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

Add note for metrics yaml definitions #167

Closed
trask opened this issue Apr 21, 2023 · 2 comments · Fixed by #177
Closed

Add note for metrics yaml definitions #167

trask opened this issue Apr 21, 2023 · 2 comments · Fixed by #177
Assignees
Labels
enhancement New feature or request semconv/md Related specifically to the markdown output of the semantic convention generator semconv Related to the semantic convention generator.

Comments

@trask
Copy link
Member

trask commented Apr 21, 2023

This isn't a blocker, as we can add the note manually to the markdown file for now, but it would be nice to add the note in the yaml definition.

Related to open-telemetry/opentelemetry-specification#3418 and open-telemetry/opentelemetry-specification#3352 (comment)

@Oberon00
Copy link
Member

Oberon00 commented Apr 25, 2023

I think this is open-telemetry/semantic-conventions#1086. The note/brief for the group is currently missing everywhere in the markdown output, except for the attributes themselves. If you agree, I'd close this as a duplicate.

@Oberon00 Oberon00 added enhancement New feature or request semconv Related to the semantic convention generator. semconv/md Related specifically to the markdown output of the semantic convention generator labels Apr 25, 2023
@joaopgrassi
Copy link
Member

joaopgrassi commented May 31, 2023

I took a quick look, I think it should be fairly easy to add/render the notes for metrics. Metrics render the brief on a description field in the table and in there we can just append the note [x] as we do for attributes.

But for other things like resource conventions which we don't have any special rendering in markdown we might need to spend more time thinking/working on it.

So, if you think it's OK, we can leave this issue open and work on adding note support for metrics only and work on the rest as part of open-telemetry/semantic-conventions#1086.

I can take and work on those individually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request semconv/md Related specifically to the markdown output of the semantic convention generator semconv Related to the semantic convention generator.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants