Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation: align kubernetes example with the community #9832

Merged
merged 1 commit into from
Nov 22, 2021

Conversation

paulfantom
Copy link
Contributor

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

…xins

Signed-off-by: paulfantom <pawel@krupa.net.pl>
@brancz
Copy link
Member

brancz commented Nov 22, 2021

Completely agree. It also aligns with the Kubernetes structured logging conventions and the general instrumentation conventions. As a matter of fact it has probably been damaging that we've had these two documented for so long. Thank you so much for opening this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants