Skip to content

[receiver/splunkenterprise] KVStore metrics must all be enabled to see data for any of them #41527

@michael-burt

Description

@michael-burt

Component(s)

receiver/splunkenterprise

What happened?

Description

There are a few difrerent KVStore metrics collected by the Splunk Enterprise Receiver:


#'services/kvstore/status'
  splunk.kvstore.status:
    enabled: false
    description: This is the overall status of the kvstore for the given deployment.
    unit: '{status}'
    gauge:
      value_type: int
    attributes: [splunk.kvstore.storage.engine, splunk.kvstore.external, splunk.kvstore.status.value, splunk.splunkd.build, splunk.splunkd.version]
  splunk.kvstore.replication.status:
    enabled: false
    description: Replication status of the KV store.
    unit: '{status}'
    gauge:
      value_type: int
    attributes: [splunk.kvstore.status.value, splunk.splunkd.build, splunk.splunkd.version]
  splunk.kvstore.backup.status:
    enabled: false
    description: Backup and restore status of the KV store.
    unit: '{status}'
    gauge:
      value_type: int
    attributes: [splunk.kvstore.status.value, splunk.splunkd.build, splunk.splunkd.version] 

This logic is present in scraper.go

	if !s.conf.Metrics.SplunkKvstoreStatus.Enabled ||
		!s.conf.Metrics.SplunkKvstoreReplicationStatus.Enabled ||
		!s.conf.Metrics.SplunkKvstoreBackupStatus.Enabled ||
		!s.splunkClient.isConfigured(typeCm) {
		return
	}

This means that a configuration like this is actually invalid:

receivers:
  splunkenterprise:
    cluster_master:
      auth:
        authenticator: basicauth/client
      endpoint: https://localhost:8089
    metrics:
      splunk.kvstore.status:
        enabled: true
      splunk.kvstore.replication.status:
        enabled: false

Steps to Reproduce

Expected Result

I would expect that I can configure the collector such that I only enable a subset of KVStore metrics

Actual Result

When I try to enable just one metric, it does not get collected due to the issue described above.

Collector version

0.130.0

Environment information

Environment

OS: (e.g., "Ubuntu 20.04")
Compiler(if manually compiled): (e.g., "go 14.2")

OpenTelemetry Collector configuration

Log output

Additional context

No response

Tip

React with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding +1 or me too, to help us triage it. Learn more here.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions