[comment]: <> (Code generated by mdatagen. DO NOT EDIT.)

# splunkenterprise

## Default Metrics

The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

```yaml
metrics:
  <metric_name>:
    enabled: false
```

### splunk.data.indexes.extended.bucket.count

Count of buckets per index

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {buckets} | Gauge | Int |

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.index.name | The name of the index reporting a specific KPI | Any Str |

### splunk.data.indexes.extended.event.count

Count of events for index, excluding frozen events. Approximately equal to the event_count sum of all buckets.

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {events} | Gauge | Int |

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.index.name | The name of the index reporting a specific KPI | Any Str |

### splunk.data.indexes.extended.raw.size

Size in bytes on disk of the <bucket>/rawdata/ directories of all buckets in this index, excluding frozen

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| By | Gauge | Int |

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.index.name | The name of the index reporting a specific KPI | Any Str |

### splunk.data.indexes.extended.total.size

Size in bytes on disk of this index

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| By | Gauge | Int |

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.index.name | The name of the index reporting a specific KPI | Any Str |

### splunk.indexer.throughput

Gauge tracking average bytes per second throughput of indexer

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| By/s | Gauge | Double |

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.indexer.status | The status message reported for a specific object | Any Str |

### splunk.license.index.usage

Gauge tracking the indexed license usage per index

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| By | Gauge | Int |

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.index.name | The name of the index reporting a specific KPI | Any Str |

### splunk.server.introspection.queues.current

Gauge tracking current length of queue

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {queues} | Gauge | Int |

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.queue.name | The name of the queue reporting a specific KPI | Any Str |

### splunk.server.introspection.queues.current.bytes

Gauge tracking current bytes waiting in queue

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| By | Gauge | Int |

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.queue.name | The name of the queue reporting a specific KPI | Any Str |

## Optional Metrics

The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration:

```yaml
metrics:
  <metric_name>:
    enabled: true
```

### splunk.data.indexes.extended.bucket.event.count

Count of events in this bucket super-directory

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {events} | Gauge | Int |

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.index.name | The name of the index reporting a specific KPI | Any Str |
| splunk.bucket.dir | The bucket super-directory (home, cold, thawed) for each index | Any Str |

### splunk.data.indexes.extended.bucket.hot.count

(If size > 0) Number of hot buckets

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {buckets} | Gauge | Int |

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.index.name | The name of the index reporting a specific KPI | Any Str |
| splunk.bucket.dir | The bucket super-directory (home, cold, thawed) for each index | Any Str |

### splunk.data.indexes.extended.bucket.warm.count

(If size > 0) Number of warm buckets

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {buckets} | Gauge | Int |

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.index.name | The name of the index reporting a specific KPI | Any Str |
| splunk.bucket.dir | The bucket super-directory (home, cold, thawed) for each index | Any Str |