Clarify that unit must be a suffix for metric names for Prometheus #4057
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
4 tasks
carlosalberto
changed the title
dashpole
force-pushed
the
clarify_unit_location
branch
from
5071d15
to
e8fdae7
Compare
dashpole
force-pushed
the
clarify_unit_location
branch
from
e8fdae7
to
3dfb383
Compare
|
Thanks @dashpole! |
carlosalberto
approved these changes
May 23, 2024
trask
approved these changes
May 23, 2024
arminru
approved these changes
May 24, 2024
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.
I found this confusion while reviewing open-telemetry/opentelemetry-dotnet#5646 (comment). The intention is for unit to be added in the same fashion for both OpenMetrics and non-OpenMetrics names.
Before this change, the name
seconds_before_my_birthdaywould not have a unit suffix appended. While this is a conceivable name, it isn't compliant with OpenMetrics, which is the intention of the spec. Instead, it needs to be changed toseconds_before_my_birthday_secondsto be compliant with the OpenMetrics spec.This change will prevent Exporters from needing to special-case unit handling for OpenMetrics vs non-OpenMetrics.
@open-telemetry/wg-prometheus @reyang @robertcoltheart