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 guidance on abbreviation usage in semantic attribute names #602

Closed
trask opened this issue Dec 12, 2023 · 3 comments · Fixed by #1121
Closed

Add guidance on abbreviation usage in semantic attribute names #602

trask opened this issue Dec 12, 2023 · 3 comments · Fixed by #1121
Assignees

Comments

@trask
Copy link
Member

trask commented Dec 12, 2023

ECS has https://www.elastic.co/guide/en/ecs/8.9/ecs-guidelines.html#_guidelines_for_field_names

Avoid abbreviations when possible

  • Exceptions can be made, when the name used for the concept is too strongly in favor of the abbreviation. Example: ip fields, or field sets such as os, geo.

It would be good to document some (same or different) guidance for OpenTelemetry semantic conventions to help with:

(and probably others, these are just ones on top of mind)

@jcocchi
Copy link

jcocchi commented Feb 9, 2024

+1 for documentation and guidance on abbreviations, but I'm in favor of using common abbreviations where reasonable to reduce overhead

db is a prefix for most database semantic conventions, and I don't think using database instead adds value

@trask
Copy link
Member Author

trask commented Apr 25, 2024

I'm unlinking this from the Database semconv project board as I think db is a common enough abbreviation to justify using it.

Some examples:

@trisch-me
Copy link
Contributor

trisch-me commented Jun 4, 2024

@trask should we proceed on this guidance?
I have a case with hw versus hardware
I would in this case vote for using hardware.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants