This documentation has an index for AI agents at /llms.txt. A Markdown version of this page is available at https://explorer.opentelemetry.io/collector/components/contrib/splunkenterprisereceiver.md.

Splunk Enterprise Receiver

OpenTelemetry Collector receiver · contrib distribution

The Splunk Enterprise Receiver is a pull based tool which enables the ingestion of performance metrics describing the operational status of a user's Splunk Enterprise deployment to an appropriate observability tool. It is designed to leverage several different data sources to gather these metrics including the introspection api endpoint and serializing results from ad-hoc searches. Because of this, care must be taken by users when enabling metrics as running searches can effect your Splunk Enterprise Deployment and introspection may fail to report for Splunk Cloud deployments. The primary purpose of this receiver is to empower those tasked with the maintenance and care of a Splunk Enterprise deployment to leverage opentelemetry and their observability toolset in their jobs.

  • Component ID: contrib-splunkenterprisereceiver
  • Name: splunkenterprisereceiver
  • Type: receiver
  • Distribution: contrib
  • Repository: opentelemetry-collector-contrib

Stability

LevelSignals
alphametrics

Metrics

MetricTypeValue typeUnitStabilityEnabledAttributesDescription
splunk.aggregation.queue.ratiogaugedouble{%}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the average indexer aggregation queue ration (%). *Note:** Search is best run against a Cluster Manager.
splunk.buckets.searchable.statusgaugeint{count}developmentnosplunk.host (string), splunk.indexer.searchable (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the number of buckets and their searchable status. *Note:** Search is best run against a Cluster Manager.
splunk.data.indexes.extended.bucket.countgaugeint{buckets}developmentnosplunk.index.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Count of buckets per index
splunk.data.indexes.extended.bucket.event.countgaugeint{events}developmentnosplunk.bucket.dir (string), splunk.index.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Count of events in this bucket super-directory. *Note:** Must be pointed at specific indexer endpoint.
splunk.data.indexes.extended.bucket.hot.countgaugeint{buckets}developmentnosplunk.bucket.dir (string), splunk.index.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)(If size > 0) Number of hot buckets. *Note:** Must be pointed at specific indexer endpoint.
splunk.data.indexes.extended.bucket.warm.countgaugeint{buckets}developmentnosplunk.bucket.dir (string), splunk.index.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)(If size > 0) Number of warm buckets. *Note:** Must be pointed at specific indexer endpoint and gathers metrics from only that indexer.
splunk.data.indexes.extended.event.countgaugeint{events}developmentnosplunk.index.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Count of events for index, excluding frozen events. Approximately equal to the event_count sum of all buckets. *Note:** Must be pointed at specific indexer endpoint and gathers metrics from only that indexer.
splunk.data.indexes.extended.raw.sizegaugeintBydevelopmentnosplunk.index.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Size in bytes on disk of the <bucket>/rawdata/ directories of all buckets in this index, excluding frozen *Note:** Must be pointed at specific indexer endpoint and gathers metrics from only that indexer.
splunk.data.indexes.extended.total.sizegaugeintBydevelopmentnosplunk.index.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Size in bytes on disk of this index *Note:** Must be pointed at specific indexer endpoint and gathers metrics from only that indexer.
splunk.healthgaugeint{status}developmentyessplunk.feature (string), splunk.feature.health (string), splunk.splunkd.build (string), splunk.splunkd.version (string)The status ('red', 'yellow', or 'green') of the Splunk server. Health of 'red' produces a 0 while all other colors produce a 1.
splunk.indexer.avg.rategaugedoublekBydevelopmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the average rate of indexed data. Note: Search is best run against a Cluster Manager.
splunk.indexer.cpu.timegaugedouble{s}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the number of indexing process cpu seconds per instance
splunk.indexer.queue.ratiogaugedouble{%}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the average indexer index queue ration (%). *Note:** Search is best run against a Cluster Manager.
splunk.indexer.raw.write.timegaugedouble{s}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the number of raw write seconds per instance
splunk.indexer.rollingrestart.statusgaugeint{status}developmentnosplunk.rollingorrestart (bool), splunk.searchable.restart (bool), splunk.splunkd.build (string), splunk.splunkd.version (string)The status of a rolling restart.
splunk.indexer.throughputgaugedoubleBy/sdevelopmentnosplunk.indexer.status (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking average bytes per second throughput of indexer. *Note:** Must be pointed at specific indexer endpoint and gathers metrics from only that indexer.
splunk.indexes.avg.sizegaugedoubleGbdevelopmentnosplunk.index.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the indexes and their average size (gb). *Note:** Search is best run against a Cluster Manager.
splunk.indexes.avg.usagegaugedouble{%}developmentnosplunk.index.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the indexes and their average usage (%). *Note:** Search is best run against a Cluster Manager.
splunk.indexes.bucket.countgaugeint{count}developmentnosplunk.index.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the indexes and their bucket counts. *Note:** Search is best run against a Cluster Manager.
splunk.indexes.median.data.agegaugeint{days}developmentnosplunk.index.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the indexes and their median data age (days). *Note:** Search is best run against a Cluster Manager.
splunk.indexes.sizegaugedoubleGbdevelopmentnosplunk.index.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the indexes and their total size (gb). *Note:** Search is best run against a Cluster Manager.
splunk.io.avg.iopsgaugeint{iops}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the average IOPs used per instance
splunk.kvstore.backup.statusgaugeint{status}developmentnosplunk.kvstore.status.value (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Backup and restore status of the KV store.
splunk.kvstore.replication.statusgaugeint{status}developmentnosplunk.kvstore.status.value (string), splunk.kvstore.storage_engine (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Replication status of the KV store.
splunk.kvstore.statusgaugeint{status}developmentnosplunk.kvstore.external (string), splunk.kvstore.status.value (string), splunk.kvstore.storage_engine (string), splunk.splunkd.build (string), splunk.splunkd.version (string)This is the overall status of the kvstore for the given deployment.
splunk.license.expiration.seconds_remaininggaugeint{seconds}developmentnosplunk.license.label (string), splunk.license.status (string), splunk.license.type (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the seconds remaining on any given Splunk License found via Splunk API. Note: This will only work on a Cluster Manager.
splunk.license.index.usagegaugeintBydevelopmentnosplunk.index.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the indexed license usage per index
splunk.parse.queue.ratiogaugedouble{%}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the average indexer parser queue ration (%). *Note:** Search is best run against a Cluster Manager.
splunk.pipeline.set.countgaugeintkBydevelopmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the number of pipeline sets per indexer. Note: Search is best run against a Cluster Manager.
splunk.scheduler.avg.execution.latencygaugedouble{ms}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the average execution latency of scheduled searches
splunk.scheduler.avg.run.timegaugedouble{ms}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the average runtime of scheduled searches
splunk.scheduler.completion.ratiogaugedouble{%}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the ratio of completed to skipped scheduled searches
splunk.search.durationgaugedouble{status}developmentnosplunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the duration in seconds of the last search probe call.
splunk.search.initiationgaugeint{status}developmentnosplunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking whether the last search probe successfully initiated a search.
splunk.search.statusgaugeint{status}developmentnosplunk.search.state (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the dispatch status of the last search probe.
splunk.search.successgaugeint{status}developmentnosplunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking whether the last search probe call was successful with the dispatch state 'DONE'.
splunk.server.introspection.queues.currentgaugeint{queues}developmentnosplunk.queue.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking current length of queue. *Note:** Must be pointed at specific indexer endpoint and gathers metrics from only that indexer.
splunk.server.introspection.queues.current.bytesgaugeintBydevelopmentnosplunk.queue.name (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking current bytes waiting in queue. *Note:** Must be pointed at specific indexer endpoint and gathers metrics from only that indexer.
splunk.server.searchartifacts.adhocgaugeint{search_artifacts}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking number of ad hoc search artifacts currently on disk. Note:* Must be pointed at specific Search Head endpoint and gathers metrics from only that Search Head. Available in builds 9.1.2312.207+ and 9.3.x+.
splunk.server.searchartifacts.adhoc.sizegaugeint{search_artifacts}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge total size (MB) of ad hoc search artifacts currently on disk. Note:* Must be pointed at specific Search Head endpoint and gathers metrics from only that Search Head. Available in builds 9.1.2312.207+ and 9.3.x+.
splunk.server.searchartifacts.completedgaugeint{search_artifacts}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking number of artifacts currently on disk that belong to finished searches. Note:* Must be pointed at specific Search Head endpoint and gathers metrics from only that Search Head. Available in builds 9.1.2312.207+ and 9.3.x+.
splunk.server.searchartifacts.completed.sizegaugeint{search_artifacts}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge total size (MB) of artifacts currently on disk that belong to finished searches. Note:* Must be pointed at specific Search Head endpoint and gathers metrics from only that Search Head. Available in builds 9.1.2312.207+ and 9.3.x+.
splunk.server.searchartifacts.incompletegaugeint{search_artifacts}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking number of artifacts currently on disk that belong to unfinished/running searches. Note:* Must be pointed at specific Search Head endpoint and gathers metrics from only that Search Head. Available in builds 9.1.2312.207+ and 9.3.x+.
splunk.server.searchartifacts.incomplete.sizegaugeint{search_artifacts}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge total size (MB) of artifacts currently on disk that belong to unfinished/running searches. Note:* Must be pointed at specific Search Head endpoint and gathers metrics from only that Search Head. Available in builds 9.1.2312.207+ and 9.3.x+.
splunk.server.searchartifacts.invalidgaugeint{search_artifacts}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking number of artifacts currently on disk that are not in a valid state, such as missing info.csv file, etc. Note:* Must be pointed at specific Search Head endpoint and gathers metrics from only that Search Head. Available in builds 9.1.2312.207+ and 9.3.x+.
splunk.server.searchartifacts.job.cache.countgaugeint{search_artifacts}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking number search artifacts metadata stored in memory, available in builds 9.1.2312.207+ and 9.3.x+.
splunk.server.searchartifacts.job.cache.sizegaugeint{mb}developmentnosplunk.host (string), splunk.searchartifacts.cache.type (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking, in megabytes, memory used to cache job status and job info of all search artifacts, available in builds 9.1.2312.207+ and 9.3.x+.
splunk.server.searchartifacts.savedsearchesgaugeint{search_artifacts}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking, for the splunk.server.searchartifacts.scheduled number of scheduled search artifacts, how many different saved-searches they belong to. Note:* Must be pointed at specific Search Head endpoint and gathers metrics from only that Search Head. Available in builds 9.1.2312.207+ and 9.3.x+.
splunk.server.searchartifacts.scheduledgaugeint{search_artifacts}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking number of scheduled search artifacts currently on disk. Note:* Must be pointed at specific Search Head endpoint and gathers metrics from only that Search Head. Available in builds 9.1.2312.207+ and 9.3.x+.
splunk.server.searchartifacts.scheduled.sizegaugeint{search_artifacts}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge total size (MB) of scheduled search artifacts currently on disk. Note:* Must be pointed at specific Search Head endpoint and gathers metrics from only that Search Head. Available in builds 9.1.2312.207+ and 9.3.x+.
splunk.typing.queue.ratiogaugedouble{%}developmentnosplunk.host (string), splunk.splunkd.build (string), splunk.splunkd.version (string)Gauge tracking the average indexer typing queue ration (%). *Note:** Search is best run against a Cluster Manager.

Attributes

AttributeTypeDescription
splunk.bucket.dirstringThe bucket super-directory (home, cold, thawed) for each index
splunk.featurestringThe Feature name from the Splunk Health Introspection Endpoint
splunk.feature.healthstringThe Health (in color form) of a Splunk Feature from the Splunk Health Introspection Endpoint
splunk.hoststringThe name of the splunk host
splunk.index.namestringThe name of the index reporting a specific KPI
splunk.indexer.searchablestringThe searchability status reported for a specific object
splunk.indexer.statusstringThe status message reported for a specific object
splunk.kvstore.externalstringValue denoting if the KV store is using an external service
splunk.kvstore.status.valuestringThe string value of the status returned when reporting on KV store using the introspection endpoint
splunk.kvstore.storage_enginestringThe backend storage used by the KV store
splunk.license.labelstringThe label of the license.
splunk.license.statusstringThe status of the license.
splunk.license.typestringThe type of license.
splunk.queue.namestringThe name of the queue reporting a specific KPI
splunk.rollingorrestartboolBoolean that indicates if there is a rolling restart or rolling upgrade in progress.
splunk.search.statestringThe dispatch state of the search
splunk.searchable.restartboolBoolean that indicates if a searchable rolling restart/upgrade in progress.t
splunk.searchartifacts.cache.typestringThe search artifacts cache type
splunk.splunkd.buildstringThe build number for this Splunk instance version
splunk.splunkd.versionstringThe splunkd version number

Data

  • JSON (latest): /data/collector/components/contrib-splunkenterprisereceiver/latest.json
  • JSON (pinned): /data/collector/components/contrib-splunkenterprisereceiver/contrib-splunkenterprisereceiver-a80831de58a9.json
  • Explore: /collector/components/contrib/splunkenterprisereceiver