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

Proofread instrument descriptions (briefs) for http.(client|server).request.duration #335

Closed
trask opened this issue Sep 20, 2023 · 2 comments · Fixed by #366
Closed

Proofread instrument descriptions (briefs) for http.(client|server).request.duration #335

trask opened this issue Sep 20, 2023 · 2 comments · Fixed by #366
Assignees
@reyang

Comments

@trask
Copy link
Member

trask commented Sep 20, 2023 •
edited
Loading

While instrument descriptions are allowed to change after stability (https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/versioning-and-stability.md#semantic-conventions-stability), changing them does have some undesirable impact: open-telemetry/opentelemetry-demo#969
@trask trask moved this to Blocker for stability in Spec: HTTP Semantic Conventions Sep 20, 2023
@trask trask changed the title Proofread all HTTP attribute descriptions (briefs) Proofread all HTTP and network attribute descriptions (briefs) Sep 27, 2023
@trask trask mentioned this issue Sep 27, 2023
Merged
2 tasks
@trask trask changed the title Proofread all HTTP and network attribute descriptions (briefs) Proofread all attribute descriptions (briefs) that are used in http.(client|server).request.duration Sep 29, 2023
@trask
Copy link
Member Author

trask commented Sep 29, 2023 •
edited
Loading

What should we do about briefs that have markdown? e.g.

HTTP response status code.

Options:

  • (a) Move the links to the note section
  • (b) Include language somewhere that metric instrument briefs should include only the textual portion, excluding markdown
  • (c) Include language somewhere clarifying that metric instrument briefs should be the exact string, including markdown

(oops, see below, there is no markdown in the above instrument briefs at least)

@trask trask mentioned this issue Sep 29, 2023
Merged
3 tasks
@trask
Copy link
Member Author

trask commented Oct 3, 2023

OOOPS! I got confused. It's only instrument descriptions (briefs) which cause these warnings, and not attribute briefs.

@trask trask changed the title Proofread all attribute descriptions (briefs) that are used in http.(client|server).request.duration Proofread instrument descriptions (briefs) for http.(client|server).request.duration Oct 3, 2023
@trask trask mentioned this issue Oct 3, 2023
Merged
2 tasks
@github-project-automation github-project-automation bot moved this from Blocker for stability to Done in Spec: HTTP Semantic Conventions Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@reyang reyang

Labels
None yet
Projects
Spec: HTTP Semantic Conventions
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve HTTP metric briefs trask/semantic-conventions
2 participants
@trask @reyang