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

Jump to bottom

Document instrument name requirements in metric API #5377

Closed
MrAlias opened this issue May 17, 2024 · 0 comments · Fixed by #5435
Closed

Document instrument name requirements in metric API #5377

MrAlias opened this issue May 17, 2024 · 0 comments · Fixed by #5435
Assignees
@MrAlias
Labels
bug Something isn't working
Milestone
v1.28.0

Comments

@MrAlias
Copy link
Contributor

MrAlias commented May 17, 2024

https://opentelemetry.io/docs/specs/otel/metrics/api/#synchronous-instrument-api

The API to construct synchronous instruments MUST accept the following parameters:

  • A name of the Instrument.
    [..]
    The API SHOULD be documented in a way to communicate to users that the name parameter needs to conform to the instrument name syntax.

It seems like we do not currently document our API in this way. We should update the documentation to comply with this recommendation.
@MrAlias MrAlias added the bug Something isn't working label May 17, 2024
@MrAlias MrAlias added this to the v1.28.0 milestone May 17, 2024
@MrAlias MrAlias mentioned this issue May 17, 2024
Closed
@MrAlias MrAlias self-assigned this May 29, 2024
@MrAlias MrAlias moved this from Needs Triage to In Progress in Go: Metric SDK (Post-GA) May 29, 2024
@MrAlias MrAlias mentioned this issue May 29, 2024
Merged
MrAlias added a commit that referenced this issue May 30, 2024
@MrAlias @XSAM
Document instrument name requirements (#5435)
baa8efe 
Fix #5377

---------

Co-authored-by: Sam Xie <sam@samxie.me>
@github-project-automation github-project-automation bot moved this from In Progress to Done in Go: Metric SDK (Post-GA) May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MrAlias MrAlias

Labels
bug Something isn't working
Projects
Go: Metric SDK (Post-GA)
Status: Done
Milestone
v1.28.0
Development

Successfully merging a pull request may close this issue.

Document instrument name requirements MrAlias/opentelemetry-go
1 participant
@MrAlias