Clarified splunk.health description

open-telemetry · Dec 5, 2024 · 2ae137c · 2ae137c
1 parent 0c5c347
commit 2ae137c
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/receiver/splunkenterprisereceiver/documentation.md b/receiver/splunkenterprisereceiver/documentation.md
@@ -43,7 +43,7 @@ Gauge tracking the number of buckets and their searchable status. *Note:** Searc
 
 ### splunk.health
 
-The status (color) of the Splunk server.
+The status (color) of the Splunk server. Health of 'red' produces a 0 while all other colors produce a 1.
 
 | Unit | Metric Type | Value Type |
 | ---- | ----------- | ---------- |

diff --git a/receiver/splunkenterprisereceiver/generated_package_test.go b/receiver/splunkenterprisereceiver/generated_package_test.go
diff --git a/receiver/splunkenterprisereceiver/internal/metadata/generated_config_test.go b/receiver/splunkenterprisereceiver/internal/metadata/generated_config_test.go
diff --git a/receiver/splunkenterprisereceiver/internal/metadata/generated_metrics.go b/receiver/splunkenterprisereceiver/internal/metadata/generated_metrics.go
diff --git a/receiver/splunkenterprisereceiver/internal/metadata/generated_metrics_test.go b/receiver/splunkenterprisereceiver/internal/metadata/generated_metrics_test.go
diff --git a/receiver/splunkenterprisereceiver/metadata.yaml b/receiver/splunkenterprisereceiver/metadata.yaml
@@ -354,7 +354,7 @@ metrics:
   #`services/server/health/splunkd/details`
   splunk.health:
     enabled: True
-    description: The status (color) of the Splunk server.
+    description: The status (color) of the Splunk server. Health of 'red' produces a 0 while all other colors produce a 1.
     unit: "{status}"
     gauge:
       value_type: int