Update prometheus_metrics_prefix documentation #8236
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
Codecov Report
|
coignetp
approved these changes
Dec 22, 2020
yzhan289
reviewed
Dec 22, 2020
| @@ -25,7 +25,7 @@ | |||
| items: | |||
| type: string | |||
| - name: prometheus_metrics_prefix | |||
| description: <PREFIX> for exposed Prometheus metrics. | |||
| description: Removes a given <PREFIX> from exposed Prometheus metrics. | |||
| value: | |||
| type: string | |||
| example: <PREFIX>_ | |||
There was a problem hiding this comment.
What is the purpose of _ after <PREFIX>?
There was a problem hiding this comment.
I guess because services adding a prefix usually add an extra _ between the prefix and the rest of the metric name for readability?
There was a problem hiding this comment.
Gotcha, so it would remove the extra _ that is also included.
yzhan289
approved these changes
Dec 22, 2020
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.
prometheus_metrics_prefixis used when the prometheus all have the same prefix and removes that prefix before submitting the metrics. See https://github.com/DataDog/integrations-core/blob/master/datadog_checks_base/datadog_checks/base/checks/openmetrics/mixins.py#L122This PR makes this behavior a bit more clear.