You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!--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`
Copy file name to clipboardExpand all lines: receiver/splunkenterprisereceiver/documentation.md
+37-8Lines changed: 37 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -444,8 +444,8 @@ This is the overall status of the kvstore for the given deployment.
444
444
445
445
| Name | Description | Values |
446
446
| ---- | ----------- | ------ |
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 |
449
449
| splunk.kvstore.status.value | The string value of the status returned when reporting on KV store using the introspection endpoint | Any Str |
450
450
451
451
### splunk.server.introspection.queues.current
@@ -478,7 +478,7 @@ Gauge tracking current bytes waiting in queue. *Note:** Must be pointed at speci
478
478
479
479
### splunk.server.searchartifacts.adhoc
480
480
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+.
482
482
483
483
| Unit | Metric Type | Value Type |
484
484
| ---- | ----------- | ---------- |
@@ -492,7 +492,7 @@ Gauge tracking number of ad hoc search artifacts currently on disk. Note:* Must
492
492
493
493
### splunk.server.searchartifacts.completed
494
494
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+.
496
496
497
497
| Unit | Metric Type | Value Type |
498
498
| ---- | ----------- | ---------- |
@@ -506,7 +506,7 @@ Gauge tracking number of artifacts currently on disk that belong to finished sea
506
506
507
507
### splunk.server.searchartifacts.incomplete
508
508
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+.
510
510
511
511
| Unit | Metric Type | Value Type |
512
512
| ---- | ----------- | ---------- |
@@ -520,7 +520,7 @@ Gauge tracking number of artifacts currently on disk that belong to unfinished/r
520
520
521
521
### splunk.server.searchartifacts.invalid
522
522
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+.
524
524
525
525
| Unit | Metric Type | Value Type |
526
526
| ---- | ----------- | ---------- |
@@ -532,9 +532,38 @@ Gauge tracking number of artifacts currently on disk that are not in a valid sta
532
532
| ---- | ----------- | ------ |
533
533
| splunk.host | The name of the splunk host | Any Str |
534
534
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
+
535
564
### splunk.server.searchartifacts.savedsearches
536
565
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+.
538
567
539
568
| Unit | Metric Type | Value Type |
540
569
| ---- | ----------- | ---------- |
@@ -548,7 +577,7 @@ Gauge tracking, for the `splunk.server.searchartifacts.scheduled` number of sche
548
577
549
578
### splunk.server.searchartifacts.scheduled
550
579
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+.
0 commit comments