docs(sdk-metrics): Update Histogram docs to reflect upper bound inclusivity #4829
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
hectorhdzg
reviewed
Jul 11, 2024
| @@ -49,7 +49,7 @@ export interface Histogram { | |||
| * | |||
| * buckets: { | |||
| * boundaries: [10, 20, 30], | |||
| * counts: [3, 3, 1, 2], | |||
| * counts: [3, 3, 2, 1], | |||
There was a problem hiding this comment.
It would be good to mention what spec describe here in the notes maybe, so is clear why the counts are like that. "buckets express the number of values that are greater than their lower bound and less than or equal to their upper bound."
|
@legendecas I think we discussed in the SIG meeting that this is not the case yet and that we'd change the code to be upper-bound inclusive, right? |
|
Yes, I fixed up a PR based on this one at #4935. |
Merged
via the queue into
open-telemetry:main
with commit Aug 22, 2024
5c1ae0a
19 of 20 checks passed
Zirak
pushed a commit
to Zirak/opentelemetry-js
that referenced
this pull request
Sep 14, 2024
…sivity (open-telemetry#4829) Co-authored-by: Hector Hernandez <[email protected]>
This was referenced Sep 19, 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.
Which problem is this PR solving?
According to the specs, histogram bucket upper bounds are inclusive. This PR contains a very small change to the docs to reflect that. This might avoid confusing a newcomer to the project.
Fixes # N/A
Short description of the changes
Type of change
Docs only
How Has This Been Tested?
N/A
Checklist: