open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Explain why custom attributes are not recommended to be placed in Otel namespaces (#3507) 

The @open-telemetry/technical-committee discussed and decided to keep the
existing recommendations but clarify them and explain the purpose.
This commit is contained in:
Tigran Najaryan 2023-05-26 11:23:42 -04:00 committed by Josh Suereth
parent cc85702f85
commit bd2b51a249
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
specification/common/attribute-naming.md
View File

@ -133,6 +133,13 @@ To do that consider a few options:
`myuniquemapapp.longitude` is likely fine). Make sure the application name `myuniquemapapp.longitude` is likely fine). Make sure the application name
does not clash with an existing semantic convention namespace. does not clash with an existing semantic convention namespace.
- It is not recommended to use existing OpenTelemetry semantic convention namespace
as a prefix for a new company- or application-specific attribute name. Doing so
may result in a name clash in the future, if OpenTelemetry decides to use that
same name for a different purpose or if some other third party instrumentation
decides to use that exact same attribute name and you combine that instrumentation
with your own.
- The name may be generally applicable to applications in the industry. In that - The name may be generally applicable to applications in the industry. In that
case consider submitting a proposal to this specification to add a new name to case consider submitting a proposal to this specification to add a new name to
the semantic conventions, and if necessary also to add a new namespace. the semantic conventions, and if necessary also to add a new namespace.