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

Generalize attribute naming recommendations #3746

Closed
jack-berg opened this issue Oct 27, 2023 · 4 comments
Closed

Generalize attribute naming recommendations #3746

jack-berg opened this issue Oct 27, 2023 · 4 comments
Assignees
Labels
spec:miscellaneous For issues that don't match any other spec label

Comments

@jack-berg
Copy link
Member

The attribute naming document provides a lot of useful guidelines that we seem to be implicitly following in metric naming conventions. Note that there's a dedicated metric semantic conventions document which seems to expand / build on the general naming recommendations.

In the 10/27 Event WG we discussed the desire to merge the event.domain and event.name attributes into a single event.name field, modeled after metric names which have the same types of namespacing and uniqueness requirements we want to achieve.

We would want the same (or much of?) the same attribute naming advice to apply to event names as well.

Can / should we generalize the attribute naming document such that it applies to metric names and event names? @open-telemetry/specs-semconv-approvers are we implicitly applying the attribute conventions to metric names today or are they somehow different?

@pyohannes
Copy link
Contributor

This was discussed in today's semantic convention SIG call.

Can / should we generalize the attribute naming document such that it applies to metric names and event names?

Yes. We agreed that both documents have the same aim, and ideally there should just be once consistent source of truth. It should also apply to metric names (and already aims to do, as it mentions pluralization guidelines). Ideally, we can merge the attribute naming document from the spec repository and the metrics semantic conventions document from the semantic convention repository.

There also was some discussion about where this document should live. The semantic convention repository seems like a better place, as opposed to the spec repository.

@jack-berg
Copy link
Member Author

The semantic-conventions repo seems like an appropriate home to me. And actually, the attribute requirement level seems to also belong in semantic-conventions.

What do you think about a two stage approach?

  1. Moving attribute-naming.md and attribute-requirement-level.md to semantic-conventions/docs/general, being careful to retain git history.
  2. Merging attribute-naming.md and relevant portions of metric.md.

@pyohannes
Copy link
Contributor

pyohannes commented Oct 31, 2023

What do you think about a two stage approach?

  1. Moving attribute-naming.md and attribute-requirement-level.md to semantic-conventions/docs/general, being careful to retain git history.
  2. Merging attribute-naming.md and relevant portions of metric.md.

Sounds good to me. @open-telemetry/specs-semconv-maintainers and @open-telemetry/specs-semconv-approvers ?

@jack-berg
Copy link
Member Author

This is resolved in #3758, semantic-conventions#493 and semantic-conventions#473.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec:miscellaneous For issues that don't match any other spec label
Projects
Status: Done
Development

No branches or pull requests

3 participants