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

Normatively define synchronous instrument record/add parameters #3082

Merged
merged 11 commits into from
Jan 30, 2023

Conversation

MrAlias
Copy link
Contributor

@MrAlias MrAlias commented Jan 5, 2023

Currently the parameters for the Add API of the Counter and UpDownCounter and the Record API of the Histogram are stated in non-normatively. Communicate these parameters for the instrument record/add APIs using normative key words adopted by this specification and defined in BCP-14.

Fix #3081

Communicate the parameters for the instrument record/add APIs using
normative key words adopted by this specification and defined in BCP-14.
@MrAlias MrAlias added spec:metrics Related to the specification/metrics directory editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. labels Jan 5, 2023
@MrAlias MrAlias requested review from a team January 5, 2023 22:20
specification/metrics/api.md Outdated Show resolved Hide resolved
specification/metrics/api.md Outdated Show resolved Hide resolved
specification/metrics/api.md Outdated Show resolved Hide resolved
specification/metrics/api.md Outdated Show resolved Hide resolved
Co-authored-by: jack-berg <[email protected]>
Co-authored-by: Robert Pająk <[email protected]>
specification/metrics/api.md Outdated Show resolved Hide resolved
specification/metrics/api.md Outdated Show resolved Hide resolved
MrAlias and others added 5 commits January 18, 2023 10:07
Feedback to these changes pointed out the original intent of the
optional parameters is not to communicate the option for APIs, but for
users to provide the values. Update the changes to match this intent.
Consistently use the same API identifier.
@jmacd jmacd merged commit b513da8 into open-telemetry:main Jan 30, 2023
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
…-telemetry#3082)

* Normatively define sync inst record params

Communicate the parameters for the instrument record/add APIs using
normative key words adopted by this specification and defined in BCP-14.

* Apply suggestions from code review

Co-authored-by: jack-berg <[email protected]>
Co-authored-by: Robert Pająk <[email protected]>

* Update specification/metrics/api.md

Co-authored-by: Robert Pająk <[email protected]>

* Address feedback, all params required

Feedback to these changes pointed out the original intent of the
optional parameters is not to communicate the option for APIs, but for
users to provide the values. Update the changes to match this intent.

* This instead of the

Consistently use the same API identifier.

* Recommend no validation instead of requiring it

---------

Co-authored-by: jack-berg <[email protected]>
Co-authored-by: Robert Pająk <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. spec:metrics Related to the specification/metrics directory
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Are metric APIs expected to restrict counter input values?
6 participants