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.

Sign up for GitHub

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 identical instrument definition for SDK. #3585

Merged
merged 4 commits into from
Jul 12, 2023
Merged

Clarify identical instrument definition for SDK. #3585

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
76e3542
Clarify identical instrument definition for SDK.
MrAlias Jul 6, 2023
6873fab
Merge branch 'main' into identical-inst
MrAlias Jul 10, 2023
60b3b2a
Merge branch 'main' into identical-inst
MrAlias Jul 12, 2023
8e7417a
Add changelog entry
MrAlias Jul 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions specification/metrics/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,9 @@ are identified by all of these fields.
Language-level features such as the distinction between integer and
floating point numbers SHOULD be considered as identifying.

The term *identical* applied to an Instrument describes instances where all
identifying fields are equal.

### General characteristics

#### Instrument name syntax
Expand Down
6 changes: 3 additions & 3 deletions specification/metrics/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -778,10 +778,10 @@ fields](./api.md#instrument) are equal. The term _distinct_ applied
to Instruments describes instances where at least one field value is
different.

Based on [the recommendations from the data
To accomidate [the recommendations from the data
model](data-model.md#opentelemetry-protocol-data-model-producer-recommendations),
the SDK MUST aggregate data from identical Instruments together in its export
pipeline.
the SDK MUST aggregate data from [identical Instruments](api.md#instrument)
together in its export pipeline.

When a duplicate instrument registration occurs, and it is not corrected with a
View, a warning SHOULD be emitted. The emitted warning SHOULD include
Expand Down