docs: add a note to serviceMonitor #345
Merged
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
Sometimes `values.yaml` fields can be slightly misleading, in this case setting `serviceMonitor.enabled=true` doesn't inherently place the label for all components (such as the admin api) and it may not be intuitive that several other configurations must be updated in order to achieve that. As such this commit adds some helper text and a link to the README to provide some hints, and more context.
rainest
requested changes
Apr 14, 2021
There was a problem hiding this comment.
I'll still try and push for brevity here 🙂
We also don't want to imply that there are admin API metrics--there aren't, and the label really should be set on one service only. A DeploymentMonitor would be more appropriate for how our metrics actaully work, but the Prometheus operator doesn't offer that.
Co-authored-by: Travis Raines <traines@konghq.com>
rainest
approved these changes
Apr 15, 2021
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.
Sometimes
values.yamlfields can be slightly misleading, inthis case setting
serviceMonitor.enabled=truedoesn't inherentlyplace the label for all components (such as the admin api) and it
may not be intuitive that several other configurations must be updated
in order to achieve that. As such this commit adds some helper text
and a link to the README to provide some hints, and more context.
Resolves #311