documentation: align kubernetes example with the community #9832
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.
Throughout the last few years, there was a lot of development in the area of prometheus integration with kubernetes. During that time we have established some guidelines in how to name a few common, identifying labels to allow easy consumption of monitoring mixins, solidify integration between various tools, and improve UX. Some of those guidelines even got into prometheus documentation in the form of code comments -https://github.com/prometheus/prometheus/blob/main/documentation/prometheus-mixin/config.libsonnet#L24.
This PR is an attempt to merge two conflicting guidelines, one that is advertised by prometheus as an example configuration and the other that is widely used by prometheus-operator, monitoring mixins, and other tools (like kube-state-metrics).
Since this is changing only an example configuration, I do not see this as a breaking change. However, I am open to being convinced otherwise :)
This is related to prometheus-operator/prometheus-operator#4415
/cc @brancz @simonpasquier