Skip to content

Commit

Permalink
[receiver/splunkentperisereceiver] Add Dispatch Artifact Collection (o…
Browse files Browse the repository at this point in the history
…pen-telemetry#35950)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

This PR adds metrics for search dispatch using the
`/services/server/status/dispatch-artifacts` API.

<!--Describe what testing was performed and which tests were added.-->
#### Testing

I added unit tests for these metrics
  • Loading branch information
michael-burt authored Oct 28, 2024
1 parent ed09990 commit 3b31e40
Show file tree
Hide file tree
Showing 11 changed files with 807 additions and 3 deletions.
27 changes: 27 additions & 0 deletions .chloggen/splunkenterprisereceiver-search-artifacts.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: splunkenterprisereceiver

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add new metrics for Splunk Enterprise dispatch artifacts

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [35950]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [user]
84 changes: 84 additions & 0 deletions receiver/splunkenterprisereceiver/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -475,3 +475,87 @@ Gauge tracking current bytes waiting in queue. *Note:** Must be pointed at speci
| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.queue.name | The name of the queue reporting a specific KPI | Any Str |

### splunk.server.searchartifacts.adhoc

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.

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

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.host | The name of the splunk host | Any Str |

### splunk.server.searchartifacts.completed

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.

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

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.host | The name of the splunk host | Any Str |

### splunk.server.searchartifacts.incomplete

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.

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

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.host | The name of the splunk host | Any Str |

### splunk.server.searchartifacts.invalid

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.

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

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.host | The name of the splunk host | Any Str |

### splunk.server.searchartifacts.savedsearches

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.

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

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.host | The name of the splunk host | Any Str |

### splunk.server.searchartifacts.scheduled

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.

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

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| splunk.host | The name of the splunk host | Any Str |

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 3b31e40

Please sign in to comment.