enabled splunk.health by default

Author: shalper2

receiver/splunkenterprisereceiver/README.md

@@ -20,7 +20,7 @@ jobs.
 
 ## Configuration
 
-By default the Splunk Enterprise receiver is not configured to gather any metrics (i.e. there are no metrics enabled by default).
+**By default the Splunk Enterprise receiver is not configured to gather any metrics other than `splunk.health`**
 
 The following settings are required, omitting them will either cause your receiver to fail to compile or result in 4/5xx return codes during scraping. 
 

receiver/splunkenterprisereceiver/documentation.md

@@ -12,6 +12,21 @@ metrics:
     enabled: false
 ```
 
+### splunk.health
+
+The status ('red', 'yellow', or 'green') of the Splunk server. Health of 'red' produces a 0 while all other colors produce a 1.
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| {status} | Gauge | Int |
+
+#### Attributes
+
+| Name | Description | Values |
+| ---- | ----------- | ------ |
+| splunk.feature | The Feature name from the Splunk Health Introspection Endpoint | Any Str |
+| splunk.feature.health | The Health (in color form) of a Splunk Feature from the Splunk Health Introspection Endpoint | Any Str |
+
 ## Optional Metrics
 
 The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration:
@@ -152,21 +167,6 @@ Size in bytes on disk of this index *Note:** Must be pointed at specific indexer
 | ---- | ----------- | ------ |
 | splunk.index.name | The name of the index reporting a specific KPI | Any Str |
 
-### splunk.health
-
-The status ('red', 'yellow', or 'green') of the Splunk server. Health of 'red' produces a 0 while all other colors produce a 1.
-
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| {status} | Gauge | Int |
-
-#### Attributes
-
-| Name | Description | Values |
-| ---- | ----------- | ------ |
-| splunk.feature | The Feature name from the Splunk Health Introspection Endpoint | Any Str |
-| splunk.feature.health | The Health (in color form) of a Splunk Feature from the Splunk Health Introspection Endpoint | Any Str |
-
 ### splunk.indexer.avg.rate
 
 Gauge tracking the average rate of indexed data. **Note:** Search is best run against a Cluster Manager.

receiver/splunkenterprisereceiver/internal/metadata/generated_config.go

@@ -352,7 +352,7 @@ metrics:
     attributes: [splunk.host]
   #`services/server/health/splunkd/details`
   splunk.health:
-    enabled: false
+    enabled: true
     description: The status ('red', 'yellow', or 'green') of the Splunk server. Health of 'red' produces a 0 while all other colors produce a 1.
     unit: "{status}"
     gauge: