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

added note about abbreviations #1121

Merged
merged 9 commits into from
Jun 6, 2024
Merged

added note about abbreviations #1121

Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
226e23d
added note about abbreviations
trisch-me Jun 4, 2024
25cf936
update toc
trisch-me Jun 4, 2024
a8d7abc
Merge branch 'main' into abbr
trisch-me Jun 4, 2024
b346355
review comments
trisch-me Jun 5, 2024
4ddc3dd
lint fix
trisch-me Jun 5, 2024
7805bc3
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Jun 5, 2024
83fc03a
add chlog
trisch-me Jun 5, 2024
bd4ba55
Merge branch 'main' into abbr
trisch-me Jun 5, 2024
e30c4ba
Merge branch 'main' into abbr
lmolkova Jun 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/general/attribute-naming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<!-- toc -->

- [Name Pluralization guidelines](#name-pluralization-guidelines)
- [Name Abbreviation guidelines](#name-abbreviation-guidelines)
trisch-me marked this conversation as resolved.
Show resolved Hide resolved
- [Name Reuse Prohibition](#name-reuse-prohibition)
- [Recommendations for OpenTelemetry Authors](#recommendations-for-opentelemetry-authors)
- [Recommendations for Application Developers](#recommendations-for-application-developers)
Expand Down Expand Up @@ -70,6 +71,14 @@ Names SHOULD follow these rules:
[Metric Name Pluralization Guidelines](./metrics.md#pluralization) SHOULD be
followed for the attribute name.

## Name Abbreviation guidelines
trisch-me marked this conversation as resolved.
Show resolved Hide resolved

Avoid abbreviations in namespace names and attribute names to prevent confusion
and misunderstandings.

Exceptions can be made for widely recognized and commonly used abbreviations.
Examples include: `ip`, `db`, `cpu`, `http`, `url`, `tcp`, `dns`, `rpc`, `ssl` etc.
trisch-me marked this conversation as resolved.
Show resolved Hide resolved

## Name Reuse Prohibition

A new attribute MUST NOT be added with the same name as an attribute that
Expand Down
Loading