diff --git a/receiver/splunkenterprisereceiver/documentation.md b/receiver/splunkenterprisereceiver/documentation.md index 8183ebfca6294..5c347c8f7b7b4 100644 --- a/receiver/splunkenterprisereceiver/documentation.md +++ b/receiver/splunkenterprisereceiver/documentation.md @@ -16,9 +16,9 @@ metrics: The status ('red', 'yellow', or 'green') of the Splunk server. Health of 'red' produces a 0 while all other colors produce a 1. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {status} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {status} | Gauge | Int | development | #### Attributes @@ -43,9 +43,9 @@ metrics: Gauge tracking the average indexer aggregation queue ration (%). *Note:** Search is best run against a Cluster Manager. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {%} | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {%} | Gauge | Double | development | #### Attributes @@ -59,9 +59,9 @@ Gauge tracking the average indexer aggregation queue ration (%). *Note:** Search Gauge tracking the number of buckets and their searchable status. *Note:** Search is best run against a Cluster Manager. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {count} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {count} | Gauge | Int | development | #### Attributes @@ -76,9 +76,9 @@ Gauge tracking the number of buckets and their searchable status. *Note:** Searc Count of buckets per index -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {buckets} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {buckets} | Gauge | Int | development | #### Attributes @@ -92,9 +92,9 @@ Count of buckets per index Count of events in this bucket super-directory. *Note:** Must be pointed at specific indexer `endpoint`. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {events} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {events} | Gauge | Int | development | #### Attributes @@ -109,9 +109,9 @@ Count of events in this bucket super-directory. *Note:** Must be pointed at spec (If size > 0) Number of hot buckets. *Note:** Must be pointed at specific indexer `endpoint`. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {buckets} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {buckets} | Gauge | Int | development | #### Attributes @@ -126,9 +126,9 @@ Count of events in this bucket super-directory. *Note:** Must be pointed at spec (If size > 0) Number of warm buckets. *Note:** Must be pointed at specific indexer `endpoint` and gathers metrics from only that indexer. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {buckets} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {buckets} | Gauge | Int | development | #### Attributes @@ -143,9 +143,9 @@ Count of events in this bucket super-directory. *Note:** Must be pointed at spec 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. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {events} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {events} | Gauge | Int | development | #### Attributes @@ -159,9 +159,9 @@ Count of events for index, excluding frozen events. Approximately equal to the e Size in bytes on disk of the /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. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| By | Gauge | Int | development | #### Attributes @@ -175,9 +175,9 @@ Size in bytes on disk of the /rawdata/ directories of all buckets in thi Size in bytes on disk of this index *Note:** Must be pointed at specific indexer `endpoint` and gathers metrics from only that indexer. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| By | Gauge | Int | development | #### Attributes @@ -191,9 +191,9 @@ Size in bytes on disk of this index *Note:** Must be pointed at specific indexer Gauge tracking the average rate of indexed data. **Note:** Search is best run against a Cluster Manager. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| KBy | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| KBy | Gauge | Double | development | #### Attributes @@ -207,9 +207,9 @@ Gauge tracking the average rate of indexed data. **Note:** Search is best run ag Gauge tracking the number of indexing process cpu seconds per instance -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {s} | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {s} | Gauge | Double | development | #### Attributes @@ -223,9 +223,9 @@ Gauge tracking the number of indexing process cpu seconds per instance Gauge tracking the average indexer index queue ration (%). *Note:** Search is best run against a Cluster Manager. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {%} | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {%} | Gauge | Double | development | #### Attributes @@ -239,9 +239,9 @@ Gauge tracking the average indexer index queue ration (%). *Note:** Search is be Gauge tracking the number of raw write seconds per instance -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {s} | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {s} | Gauge | Double | development | #### Attributes @@ -255,9 +255,9 @@ Gauge tracking the number of raw write seconds per instance The status of a rolling restart. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {status} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {status} | Gauge | Int | development | #### Attributes @@ -272,9 +272,9 @@ The status of a rolling restart. Gauge tracking average bytes per second throughput of indexer. *Note:** Must be pointed at specific indexer `endpoint` and gathers metrics from only that indexer. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By/s | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| By/s | Gauge | Double | development | #### Attributes @@ -288,9 +288,9 @@ Gauge tracking average bytes per second throughput of indexer. *Note:** Must be Gauge tracking the indexes and their average size (gb). *Note:** Search is best run against a Cluster Manager. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| Gb | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| Gb | Gauge | Double | development | #### Attributes @@ -304,9 +304,9 @@ Gauge tracking the indexes and their average size (gb). *Note:** Search is best Gauge tracking the indexes and their average usage (%). *Note:** Search is best run against a Cluster Manager. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {%} | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {%} | Gauge | Double | development | #### Attributes @@ -320,9 +320,9 @@ Gauge tracking the indexes and their average usage (%). *Note:** Search is best Gauge tracking the indexes and their bucket counts. *Note:** Search is best run against a Cluster Manager. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {count} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {count} | Gauge | Int | development | #### Attributes @@ -336,9 +336,9 @@ Gauge tracking the indexes and their bucket counts. *Note:** Search is best run Gauge tracking the indexes and their median data age (days). *Note:** Search is best run against a Cluster Manager. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {days} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {days} | Gauge | Int | development | #### Attributes @@ -352,9 +352,9 @@ Gauge tracking the indexes and their median data age (days). *Note:** Search is Gauge tracking the indexes and their total size (gb). *Note:** Search is best run against a Cluster Manager. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| Gb | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| Gb | Gauge | Double | development | #### Attributes @@ -368,9 +368,9 @@ Gauge tracking the indexes and their total size (gb). *Note:** Search is best ru Gauge tracking the average IOPs used per instance -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {iops} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {iops} | Gauge | Int | development | #### Attributes @@ -384,9 +384,9 @@ Gauge tracking the average IOPs used per instance Backup and restore status of the KV store. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {status} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {status} | Gauge | Int | development | #### Attributes @@ -400,9 +400,9 @@ Backup and restore status of the KV store. Replication status of the KV store. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {status} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {status} | Gauge | Int | development | #### Attributes @@ -416,9 +416,9 @@ Replication status of the KV store. This is the overall status of the kvstore for the given deployment. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {status} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {status} | Gauge | Int | development | #### Attributes @@ -452,9 +452,9 @@ Gauge tracking the seconds remaining on any given Splunk License found via Splun Gauge tracking the indexed license usage per index -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| By | Gauge | Int | development | #### Attributes @@ -468,9 +468,9 @@ Gauge tracking the indexed license usage per index Gauge tracking the average indexer parser queue ration (%). *Note:** Search is best run against a Cluster Manager. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {%} | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {%} | Gauge | Double | development | #### Attributes @@ -484,9 +484,9 @@ Gauge tracking the average indexer parser queue ration (%). *Note:** Search is b Gauge tracking the number of pipeline sets per indexer. **Note:** Search is best run against a Cluster Manager. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| KBy | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| KBy | Gauge | Int | development | #### Attributes @@ -500,9 +500,9 @@ Gauge tracking the number of pipeline sets per indexer. **Note:** Search is best Gauge tracking the average execution latency of scheduled searches -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {ms} | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {ms} | Gauge | Double | development | #### Attributes @@ -516,9 +516,9 @@ Gauge tracking the average execution latency of scheduled searches Gauge tracking the average runtime of scheduled searches -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {ms} | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {ms} | Gauge | Double | development | #### Attributes @@ -532,9 +532,9 @@ Gauge tracking the average runtime of scheduled searches Gauge tracking the ratio of completed to skipped scheduled searches -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {%} | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {%} | Gauge | Double | development | #### Attributes @@ -548,9 +548,9 @@ Gauge tracking the ratio of completed to skipped scheduled searches Gauge tracking the duration in seconds of the last search probe call. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {status} | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {status} | Gauge | Double | development | #### Attributes @@ -563,9 +563,9 @@ Gauge tracking the duration in seconds of the last search probe call. Gauge tracking whether the last search probe successfully initiated a search. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {status} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {status} | Gauge | Int | development | #### Attributes @@ -578,9 +578,9 @@ Gauge tracking whether the last search probe successfully initiated a search. Gauge tracking the dispatch status of the last search probe. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {status} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {status} | Gauge | Int | development | #### Attributes @@ -594,9 +594,9 @@ Gauge tracking the dispatch status of the last search probe. Gauge tracking whether the last search probe call was successful with the dispatch state 'DONE'. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {status} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {status} | Gauge | Int | development | #### Attributes @@ -609,9 +609,9 @@ Gauge tracking whether the last search probe call was successful with the dispat Gauge tracking current length of queue. *Note:** Must be pointed at specific indexer `endpoint` and gathers metrics from only that indexer. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {queues} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {queues} | Gauge | Int | development | #### Attributes @@ -625,9 +625,9 @@ Gauge tracking current length of queue. *Note:** Must be pointed at specific ind Gauge tracking current bytes waiting in queue. *Note:** Must be pointed at specific indexer `endpoint` and gathers metrics from only that indexer. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| By | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| By | Gauge | Int | development | #### Attributes @@ -641,9 +641,9 @@ Gauge tracking current bytes waiting in queue. *Note:** Must be pointed at speci 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+. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {search_artifacts} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {search_artifacts} | Gauge | Int | development | #### Attributes @@ -657,9 +657,9 @@ Gauge tracking number of ad hoc search artifacts currently on disk. Note:* Must 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+. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {search_artifacts} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {search_artifacts} | Gauge | Int | development | #### Attributes @@ -673,9 +673,9 @@ Gauge total size (MB) of ad hoc search artifacts currently on disk. Note:* Must 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+. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {search_artifacts} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {search_artifacts} | Gauge | Int | development | #### Attributes @@ -689,9 +689,9 @@ Gauge tracking number of artifacts currently on disk that belong to finished sea 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+. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {search_artifacts} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {search_artifacts} | Gauge | Int | development | #### Attributes @@ -705,9 +705,9 @@ Gauge total size (MB) of artifacts currently on disk that belong to finished sea 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+. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {search_artifacts} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {search_artifacts} | Gauge | Int | development | #### Attributes @@ -721,9 +721,9 @@ Gauge tracking number of artifacts currently on disk that belong to unfinished/r 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+. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {search_artifacts} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {search_artifacts} | Gauge | Int | development | #### Attributes @@ -737,9 +737,9 @@ Gauge total size (MB) of artifacts currently on disk that belong to unfinished/r 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+. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {search_artifacts} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {search_artifacts} | Gauge | Int | development | #### Attributes @@ -753,9 +753,9 @@ Gauge tracking number of artifacts currently on disk that are not in a valid sta Gauge tracking number search artifacts metadata stored in memory, available in builds 9.1.2312.207+ and 9.3.x+. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {search_artifacts} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {search_artifacts} | Gauge | Int | development | #### Attributes @@ -769,9 +769,9 @@ Gauge tracking number search artifacts metadata stored in memory, available in b 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+. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {mb} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {mb} | Gauge | Int | development | #### Attributes @@ -786,9 +786,9 @@ Gauge tracking, in megabytes, memory used to cache job status and job info of al 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+. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {search_artifacts} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {search_artifacts} | Gauge | Int | development | #### Attributes @@ -802,9 +802,9 @@ Gauge tracking, for the `splunk.server.searchartifacts.scheduled` number of sche 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+. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {search_artifacts} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {search_artifacts} | Gauge | Int | development | #### Attributes @@ -818,9 +818,9 @@ Gauge tracking number of scheduled search artifacts currently on disk. Note:* Mu 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+. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {search_artifacts} | Gauge | Int | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {search_artifacts} | Gauge | Int | development | #### Attributes @@ -834,9 +834,9 @@ Gauge total size (MB) of scheduled search artifacts currently on disk. Note:* Mu Gauge tracking the average indexer typing queue ration (%). *Note:** Search is best run against a Cluster Manager. -| Unit | Metric Type | Value Type | -| ---- | ----------- | ---------- | -| {%} | Gauge | Double | +| Unit | Metric Type | Value Type | Stability | +| ---- | ----------- | ---------- | --------- | +| {%} | Gauge | Double | development | #### Attributes diff --git a/receiver/splunkenterprisereceiver/metadata.yaml b/receiver/splunkenterprisereceiver/metadata.yaml index 0721c2a738c88..339c66a8b19a6 100644 --- a/receiver/splunkenterprisereceiver/metadata.yaml +++ b/receiver/splunkenterprisereceiver/metadata.yaml @@ -74,6 +74,8 @@ metrics: splunk.license.index.usage: enabled: false description: Gauge tracking the indexed license usage per index + stability: + level: development unit: By gauge: value_type: int @@ -81,6 +83,8 @@ metrics: splunk.scheduler.avg.execution.latency: enabled: false description: Gauge tracking the average execution latency of scheduled searches + stability: + level: development unit: '{ms}' gauge: value_type: double @@ -88,6 +92,8 @@ metrics: splunk.scheduler.completion.ratio: enabled: false description: Gauge tracking the ratio of completed to skipped scheduled searches + stability: + level: development unit: '{%}' gauge: value_type: double @@ -95,6 +101,8 @@ metrics: splunk.indexer.avg.rate: enabled: false description: Gauge tracking the average rate of indexed data. **Note:** Search is best run against a Cluster Manager. + stability: + level: development unit: KBy gauge: value_type: double @@ -102,6 +110,8 @@ metrics: splunk.pipeline.set.count: enabled: false description: Gauge tracking the number of pipeline sets per indexer. **Note:** Search is best run against a Cluster Manager. + stability: + level: development unit: KBy gauge: value_type: int @@ -109,6 +119,8 @@ metrics: splunk.parse.queue.ratio: enabled: false description: Gauge tracking the average indexer parser queue ration (%). *Note:** Search is best run against a Cluster Manager. + stability: + level: development unit: '{%}' gauge: value_type: double @@ -116,6 +128,8 @@ metrics: splunk.aggregation.queue.ratio: enabled: false description: Gauge tracking the average indexer aggregation queue ration (%). *Note:** Search is best run against a Cluster Manager. + stability: + level: development unit: '{%}' gauge: value_type: double @@ -123,6 +137,8 @@ metrics: splunk.typing.queue.ratio: enabled: false description: Gauge tracking the average indexer typing queue ration (%). *Note:** Search is best run against a Cluster Manager. + stability: + level: development unit: '{%}' gauge: value_type: double @@ -130,6 +146,8 @@ metrics: splunk.indexer.queue.ratio: enabled: false description: Gauge tracking the average indexer index queue ration (%). *Note:** Search is best run against a Cluster Manager. + stability: + level: development unit: '{%}' gauge: value_type: double @@ -137,6 +155,8 @@ metrics: splunk.scheduler.avg.run.time: enabled: false description: Gauge tracking the average runtime of scheduled searches + stability: + level: development unit: '{ms}' gauge: value_type: double @@ -144,6 +164,8 @@ metrics: splunk.indexer.raw.write.time: enabled: false description: Gauge tracking the number of raw write seconds per instance + stability: + level: development unit: '{s}' gauge: value_type: double @@ -151,6 +173,8 @@ metrics: splunk.indexer.cpu.time: enabled: false description: Gauge tracking the number of indexing process cpu seconds per instance + stability: + level: development unit: '{s}' gauge: value_type: double @@ -158,6 +182,8 @@ metrics: splunk.io.avg.iops: enabled: false description: Gauge tracking the average IOPs used per instance + stability: + level: development unit: '{iops}' gauge: value_type: int @@ -165,6 +191,8 @@ metrics: splunk.buckets.searchable.status: enabled: false description: Gauge tracking the number of buckets and their searchable status. *Note:** Search is best run against a Cluster Manager. + stability: + level: development unit: '{count}' gauge: value_type: int @@ -172,6 +200,8 @@ metrics: splunk.indexes.bucket.count: enabled: false description: Gauge tracking the indexes and their bucket counts. *Note:** Search is best run against a Cluster Manager. + stability: + level: development unit: '{count}' gauge: value_type: int @@ -179,6 +209,8 @@ metrics: splunk.indexes.size: enabled: false description: Gauge tracking the indexes and their total size (gb). *Note:** Search is best run against a Cluster Manager. + stability: + level: development unit: Gb gauge: value_type: double @@ -186,6 +218,8 @@ metrics: splunk.indexes.avg.size: enabled: false description: Gauge tracking the indexes and their average size (gb). *Note:** Search is best run against a Cluster Manager. + stability: + level: development unit: Gb gauge: value_type: double @@ -193,6 +227,8 @@ metrics: splunk.indexes.avg.usage: enabled: false description: Gauge tracking the indexes and their average usage (%). *Note:** Search is best run against a Cluster Manager. + stability: + level: development unit: '{%}' gauge: value_type: double @@ -200,6 +236,8 @@ metrics: splunk.indexes.median.data.age: enabled: false description: Gauge tracking the indexes and their median data age (days). *Note:** Search is best run against a Cluster Manager. + stability: + level: development unit: '{days}' gauge: value_type: int @@ -209,6 +247,8 @@ metrics: splunk.indexer.throughput: enabled: false description: Gauge tracking average bytes per second throughput of indexer. *Note:** Must be pointed at specific indexer `endpoint` and gathers metrics from only that indexer. + stability: + level: development unit: By/s gauge: value_type: double @@ -218,6 +258,8 @@ metrics: splunk.data.indexes.extended.total.size: enabled: false description: Size in bytes on disk of this index *Note:** Must be pointed at specific indexer `endpoint` and gathers metrics from only that indexer. + stability: + level: development unit: By gauge: value_type: int @@ -225,6 +267,8 @@ metrics: splunk.data.indexes.extended.event.count: enabled: false description: 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. + stability: + level: development unit: '{events}' gauge: value_type: int @@ -232,6 +276,8 @@ metrics: splunk.data.indexes.extended.bucket.count: enabled: false description: Count of buckets per index + stability: + level: development unit: '{buckets}' gauge: value_type: int @@ -239,6 +285,8 @@ metrics: splunk.data.indexes.extended.raw.size: enabled: false description: Size in bytes on disk of the /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. + stability: + level: development unit: By gauge: value_type: int @@ -247,6 +295,8 @@ metrics: splunk.data.indexes.extended.bucket.event.count: enabled: false description: Count of events in this bucket super-directory. *Note:** Must be pointed at specific indexer `endpoint`. + stability: + level: development unit: '{events}' gauge: value_type: int @@ -254,6 +304,8 @@ metrics: splunk.data.indexes.extended.bucket.hot.count: enabled: false description: (If size > 0) Number of hot buckets. *Note:** Must be pointed at specific indexer `endpoint`. + stability: + level: development unit: '{buckets}' gauge: value_type: int @@ -261,6 +313,8 @@ metrics: splunk.data.indexes.extended.bucket.warm.count: enabled: false description: (If size > 0) Number of warm buckets. *Note:** Must be pointed at specific indexer `endpoint` and gathers metrics from only that indexer. + stability: + level: development unit: '{buckets}' gauge: value_type: int @@ -269,6 +323,8 @@ metrics: splunk.server.introspection.queues.current: enabled: false description: Gauge tracking current length of queue. *Note:** Must be pointed at specific indexer `endpoint` and gathers metrics from only that indexer. + stability: + level: development unit: '{queues}' gauge: value_type: int @@ -276,6 +332,8 @@ metrics: splunk.server.introspection.queues.current.bytes: enabled: false description: Gauge tracking current bytes waiting in queue. *Note:** Must be pointed at specific indexer `endpoint` and gathers metrics from only that indexer. + stability: + level: development unit: By gauge: value_type: int @@ -284,6 +342,8 @@ metrics: splunk.kvstore.status: enabled: false description: This is the overall status of the kvstore for the given deployment. + stability: + level: development unit: '{status}' gauge: value_type: int @@ -291,6 +351,8 @@ metrics: splunk.kvstore.replication.status: enabled: false description: Replication status of the KV store. + stability: + level: development unit: '{status}' gauge: value_type: int @@ -298,6 +360,8 @@ metrics: splunk.kvstore.backup.status: enabled: false description: Backup and restore status of the KV store. + stability: + level: development unit: '{status}' gauge: value_type: int @@ -306,6 +370,8 @@ metrics: splunk.server.searchartifacts.adhoc: enabled: false description: 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+. + stability: + level: development unit: "{search_artifacts}" gauge: monotonic: false @@ -315,6 +381,8 @@ metrics: splunk.server.searchartifacts.scheduled: enabled: false description: 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+. + stability: + level: development unit: "{search_artifacts}" gauge: monotonic: false @@ -324,6 +392,8 @@ metrics: splunk.server.searchartifacts.completed: enabled: false description: 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+. + stability: + level: development unit: "{search_artifacts}" gauge: monotonic: false @@ -333,6 +403,8 @@ metrics: splunk.server.searchartifacts.incomplete: enabled: false description: 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+. + stability: + level: development unit: "{search_artifacts}" gauge: monotonic: false @@ -342,6 +414,8 @@ metrics: splunk.server.searchartifacts.invalid: enabled: false description: 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+. + stability: + level: development unit: "{search_artifacts}" gauge: monotonic: false @@ -351,6 +425,8 @@ metrics: splunk.server.searchartifacts.savedsearches: enabled: false description: 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+. + stability: + level: development unit: "{search_artifacts}" gauge: monotonic: false @@ -360,6 +436,8 @@ metrics: splunk.server.searchartifacts.job.cache.size: enabled: false description: 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+. + stability: + level: development unit: "{mb}" gauge: monotonic: false @@ -369,6 +447,8 @@ metrics: splunk.server.searchartifacts.job.cache.count: enabled: false description: Gauge tracking number search artifacts metadata stored in memory, available in builds 9.1.2312.207+ and 9.3.x+. + stability: + level: development unit: "{search_artifacts}" gauge: monotonic: false @@ -378,6 +458,8 @@ metrics: splunk.server.searchartifacts.adhoc.size: enabled: false description: 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+. + stability: + level: development unit: "{search_artifacts}" gauge: monotonic: false @@ -387,6 +469,8 @@ metrics: splunk.server.searchartifacts.scheduled.size: enabled: false description: 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+. + stability: + level: development unit: "{search_artifacts}" gauge: monotonic: false @@ -396,6 +480,8 @@ metrics: splunk.server.searchartifacts.completed.size: enabled: false description: 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+. + stability: + level: development unit: "{search_artifacts}" gauge: monotonic: false @@ -405,6 +491,8 @@ metrics: splunk.server.searchartifacts.incomplete.size: enabled: false description: 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+. + stability: + level: development unit: "{search_artifacts}" gauge: monotonic: false @@ -415,6 +503,8 @@ metrics: splunk.health: enabled: true description: The status ('red', 'yellow', or 'green') of the Splunk server. Health of 'red' produces a 0 while all other colors produce a 1. + stability: + level: development unit: "{status}" gauge: value_type: int @@ -423,6 +513,8 @@ metrics: splunk.indexer.rollingrestart.status: enabled: false description: The status of a rolling restart. + stability: + level: development unit: "{status}" gauge: value_type: int @@ -432,6 +524,8 @@ metrics: splunk.search.duration: enabled: false description: Gauge tracking the duration in seconds of the last search probe call. + stability: + level: development unit: "{status}" gauge: value_type: double @@ -439,6 +533,8 @@ metrics: splunk.search.initiation: enabled: false description: Gauge tracking whether the last search probe successfully initiated a search. + stability: + level: development unit: "{status}" gauge: value_type: int @@ -446,6 +542,8 @@ metrics: splunk.search.status: enabled: false description: Gauge tracking the dispatch status of the last search probe. + stability: + level: development unit: "{status}" gauge: value_type: int @@ -453,6 +551,8 @@ metrics: splunk.search.success: enabled: false description: Gauge tracking whether the last search probe call was successful with the dispatch state 'DONE'. + stability: + level: development unit: "{status}" gauge: value_type: int