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

Reword metrics spec to clarify what "client" means #1918

Closed
aabmass opened this issue Sep 10, 2021 · 3 comments · Fixed by #1930
Closed

Reword metrics spec to clarify what "client" means #1918

aabmass opened this issue Sep 10, 2021 · 3 comments · Fixed by #1930
Assignees
Labels
spec:metrics Related to the specification/metrics directory

Comments

@aabmass
Copy link
Member

aabmass commented Sep 10, 2021

In both the metrics API and SDK specs, I see a mix of "the API", "the client", and "individual language client" which are all referring to a hypothetical implementation of the spec. I think "client" is a bit overloaded and it's unclear if this refers to an implementation or the developer using the implementation. In the tracing spec, I do also see "OpenTelemetry client authors".

I'm happy to take make a PR trying to refine the wording @reyang.

@aabmass aabmass added the spec:metrics Related to the specification/metrics directory label Sep 10, 2021
@reyang reyang assigned aabmass and unassigned bogdandrutu Sep 14, 2021
@reyang
Copy link
Member

reyang commented Sep 14, 2021

@aabmass I suggest that we align with "OpenTelemetry client authors".

@reyang reyang added this to the Metrics API/SDK Feature Freeze milestone Sep 14, 2021
@aabmass
Copy link
Member Author

aabmass commented Sep 14, 2021

@reyang do you mean changing "the client" and "individual language client" to "OpenTelemetry client authors"? I personally like "the API"/"the SDK" the most. It is the most clear to me, highlights the different responsibilities of API vs SDK, and is the most widely used in the tracing spec.

@reyang
Copy link
Member

reyang commented Sep 16, 2021

@aabmass I've created a PR #1930 combining the ideas from the discussion here. Please help to review.

@reyang reyang self-assigned this Sep 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec:metrics Related to the specification/metrics directory
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants