Skip to content

Commit

Permalink
Explain why custom attributes are not recommended to be placed in Ote…
Browse files Browse the repository at this point in the history
…l namespaces (#3507)

The @open-telemetry/technical-committee discussed and decided to keep the
existing recommendations but clarify them and explain the purpose.
  • Loading branch information
tigrannajaryan authored and jsuereth committed Nov 16, 2023
1 parent cc85702 commit bd2b51a
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions specification/common/attribute-naming.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,13 @@ To do that consider a few options:
`myuniquemapapp.longitude` is likely fine). Make sure the application name
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
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.
Expand Down

0 comments on commit bd2b51a

Please sign in to comment.