-
Notifications
You must be signed in to change notification settings - Fork 897
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
Record-level attribute semantic conventions common for all telemetry signal types #2488
Comments
For each signal some signal-specific conventions are defined. There are span name, kind, links and parent/child structures for spans and metric name and instrument type for metrics. The attributes, however, should have the same semantics regardless of where they occur (this should also hold true for resource attributes since we (currently) don't have any overlap with the record-level attributes). Both suggestion 1 and 2 should work but having them separate files/folders would allow for separate code owners to be defined as there are dedicated trace/metrics/logs-approver teams in the spec repo. The shared attributes would then be in the common folder where all teams can be designated as owners. It has been a while since I worked on the semantic conventions generator tool (https://github.com/open-telemetry/build-tools/tree/main/semantic-conventions) but I'm certain that some adaptions would be necessary to make it work this way. I think having a |
(2) sounds feasible to me, I think this is what @tedsuo proposed in #1977. I think we also don't want to miss the ability to have a different document status for different signals. HTTP semantic conventions for traces might be "Feature-freeze", while those for metrics might still be "Experimental". This becomes more challenging as attributes are shared across signals. |
+1 this is also well aligned with the well-established Elastic Common Schema. |
Problem
Specification has a dedicated place for record-level semantic conventions for each signal. Those are spread across several places, though many of the attribute-related conventions should be considered common. For example, http
metrics
vsspans
or RPCmetrics
vsspans
list a lot of common attributes.Also, there are conventions provided in some areas for spans (e.g.
database
) which are not present for metrics, yet might be considered largely relevant. This is even more true for logs, where onlymedia
conventions are defined as of nowWhile each signal has its own specifics, I believe we should use the same semantic conventions for the shared attributes and keep everything else (signal-specific attributes, instrument names) consistent
Proposals
Some possible solutions that come to my mind:
The text was updated successfully, but these errors were encountered: