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

Clarify integer count instrument units #2210

Merged

Conversation

pichlermarc
Copy link
Member

This PR clarifies the units that should be used for instruments that measure an integer count.

The spec mentioned that

Instruments that measure an integer count of something SHOULD use the default unit 1 (the unity) and annotations with curly braces to give additional meaning. For example {packets}, {errors}, {faults}, etc.

Which, due to the use of "and" in the language, could be interpreted that units should be written as 1{packets}, 1{errors} and 1{faults}. According to UCUM, however, {packets} semantically is equivalent to 1{packets}.

To prevent this interpretation, this PR clarifies that the leading 1 should be omitted.

@arminru arminru added area:semantic-conventions Related to semantic conventions spec:metrics Related to the specification/metrics directory labels Dec 13, 2021
@bogdandrutu
Copy link
Member

@arminru can you please rebase and merge this PR since you have all the right access?

@arminru arminru enabled auto-merge (squash) December 14, 2021 18:08
@arminru arminru merged commit e4d0c4c into open-telemetry:main Dec 14, 2021
@arminru arminru deleted the clarify-instrument-units branch December 14, 2021 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:semantic-conventions Related to semantic conventions spec:metrics Related to the specification/metrics directory
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants