Skip to content

Commit 64481ce

Browse files
michael-burtsbylica-splunk
authored andcommitted
[receiver/splunkenterprise] Adding Search Artifact Cache Metrics (open-telemetry#36181)
<!--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 search artifact cache metrics to the splunkenterprisereceiver. <!--Describe the documentation added.--> #### Documentation `metadata.yaml`
1 parent 062a24a commit 64481ce

File tree

10 files changed

+323
-43
lines changed

10 files changed

+323
-43
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: enhancement
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: splunkenterprisereceiver
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Add new metrics for Splunk Enterprise dispatch artifacts caches
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [36181]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: [user]

receiver/splunkenterprisereceiver/documentation.md

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -444,8 +444,8 @@ This is the overall status of the kvstore for the given deployment.
444444

445445
| Name | Description | Values |
446446
| ---- | ----------- | ------ |
447-
| splunk.kvstore.storage.engine | The backend storage used by the KV store. | Any Str |
448-
| splunk.kvstore.external | Value denoting if the KV store is using an external service. | Any Str |
447+
| splunk.kvstore.storage.engine | The backend storage used by the KV store | Any Str |
448+
| splunk.kvstore.external | Value denoting if the KV store is using an external service | Any Str |
449449
| splunk.kvstore.status.value | The string value of the status returned when reporting on KV store using the introspection endpoint | Any Str |
450450

451451
### splunk.server.introspection.queues.current
@@ -478,7 +478,7 @@ Gauge tracking current bytes waiting in queue. *Note:** Must be pointed at speci
478478

479479
### splunk.server.searchartifacts.adhoc
480480

481-
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.
481+
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+.
482482

483483
| Unit | Metric Type | Value Type |
484484
| ---- | ----------- | ---------- |
@@ -492,7 +492,7 @@ Gauge tracking number of ad hoc search artifacts currently on disk. Note:* Must
492492

493493
### splunk.server.searchartifacts.completed
494494

495-
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.
495+
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+.
496496

497497
| Unit | Metric Type | Value Type |
498498
| ---- | ----------- | ---------- |
@@ -506,7 +506,7 @@ Gauge tracking number of artifacts currently on disk that belong to finished sea
506506

507507
### splunk.server.searchartifacts.incomplete
508508

509-
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.
509+
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+.
510510

511511
| Unit | Metric Type | Value Type |
512512
| ---- | ----------- | ---------- |
@@ -520,7 +520,7 @@ Gauge tracking number of artifacts currently on disk that belong to unfinished/r
520520

521521
### splunk.server.searchartifacts.invalid
522522

523-
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.
523+
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+.
524524

525525
| Unit | Metric Type | Value Type |
526526
| ---- | ----------- | ---------- |
@@ -532,9 +532,38 @@ Gauge tracking number of artifacts currently on disk that are not in a valid sta
532532
| ---- | ----------- | ------ |
533533
| splunk.host | The name of the splunk host | Any Str |
534534

535+
### splunk.server.searchartifacts.job.cache.count
536+
537+
Gauge tracking number search artifacts metadata stored in memory, available in builds 9.1.2312.207+ and 9.3.x+.
538+
539+
| Unit | Metric Type | Value Type |
540+
| ---- | ----------- | ---------- |
541+
| {search_artifacts} | Gauge | Int |
542+
543+
#### Attributes
544+
545+
| Name | Description | Values |
546+
| ---- | ----------- | ------ |
547+
| splunk.host | The name of the splunk host | Any Str |
548+
549+
### splunk.server.searchartifacts.job.cache.size
550+
551+
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+.
552+
553+
| Unit | Metric Type | Value Type |
554+
| ---- | ----------- | ---------- |
555+
| {mb} | Gauge | Int |
556+
557+
#### Attributes
558+
559+
| Name | Description | Values |
560+
| ---- | ----------- | ------ |
561+
| splunk.host | The name of the splunk host | Any Str |
562+
| splunk.searchartifacts.cache.type | The search artifacts cache type | Any Str |
563+
535564
### splunk.server.searchartifacts.savedsearches
536565

537-
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.
566+
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+.
538567

539568
| Unit | Metric Type | Value Type |
540569
| ---- | ----------- | ---------- |
@@ -548,7 +577,7 @@ Gauge tracking, for the `splunk.server.searchartifacts.scheduled` number of sche
548577

549578
### splunk.server.searchartifacts.scheduled
550579

551-
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.
580+
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+.
552581

553582
| Unit | Metric Type | Value Type |
554583
| ---- | ----------- | ---------- |

receiver/splunkenterprisereceiver/internal/metadata/generated_config.go

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

receiver/splunkenterprisereceiver/internal/metadata/generated_config_test.go

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)