Splunkenterprisereceiver add health metric (#36695) #36695
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Initial commit * Corrected structs to fit json API response * Added to changelog * PR number added to changelog
atoulme
reviewed
Dec 6, 2024
atoulme
reviewed
Dec 6, 2024
atoulme
reviewed
Dec 6, 2024
|
Build fails with
|
macolby42
changed the title
atoulme
reviewed
Dec 10, 2024
| @@ -156,3 +157,17 @@ type DispatchArtifactContent struct { | |||
| StatusCacheSize string `json:"cached_job_status_status_csv_size_mb"` | |||
| CacheTotalEntries string `json:"cached_job_status_total_entries"` | |||
| } | |||
|
|
|||
| // '/services/server/health/splunkd/details | |||
| type HealthArtifacts struct { | |||
There was a problem hiding this comment.
Suggested change
| type HealthArtifacts struct { | |
| type healthArtifacts struct { |
limit your exported API to the minimum to avoid dependencies down the road using your internal structs.
atoulme
reviewed
Dec 10, 2024
| Entries []HealthArtifactEntry `json:"entry"` | ||
| } | ||
|
|
||
| type HealthArtifactEntry struct { |
There was a problem hiding this comment.
Suggested change
| type HealthArtifactEntry struct { | |
| type healthArtifactEntry struct { |
atoulme
reviewed
Dec 10, 2024
| Content HealthDetails `json:"content"` | ||
| } | ||
|
|
||
| type HealthDetails struct { |
There was a problem hiding this comment.
Suggested change
| type HealthDetails struct { | |
| type healthDetails struct { |
atoulme
reviewed
Dec 10, 2024
| | 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 | |
There was a problem hiding this comment.
sure you need that? you already get the status via the value right?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds
splunk.healthmetric that uses the introspection endpoint at/services/server/health/splunkd/details. The metric features 2 attributes:splunk.feature: Describes the part of the server's featuresplunk.feature.health: Describes (in red, yellow, green) the health status of the given featureThe metric will remain a value of 1 unless the feature's health becomes 'red.'
Testing
Built a custom version of splunk-otel-collector that referenced this code. Then ran it on a Splunk stack, and received metrics out. Also created generated tests.
Documentation
Added an entry to
documentation.mddescribing the new metric.