Clarify usage of "otel." attribute namespace (#1640)

I noticed developers adding their own attributes to this namespace
without going through the specification. We need to regulate this
namespace through the specification, just like we do it for other
semantic conventions.
This commit is contained in:
Tigran Najaryan 2021-04-28 10:38:46 -04:00 committed by Josh Suereth
parent 8de36bfb30
commit cb6ead3c7a
1 changed files with 14 additions and 0 deletions

View File

@ -130,3 +130,17 @@ It is recommended to limit names to printable Basic Latin characters
(more precisely to
[U+0021 .. U+007E](https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)#Table_of_characters)
subset of Unicode code points).
## otel.* Namespace
Attribute and label names that start with `otel.` are reserved to be defined by
OpenTelemetry specification. These are typically used to express OpenTelemetry
concepts in formats that don't have a corresponding concept.
For example, the `otel.library.name` attribute is used to record the
instrumentation library name, which is an OpenTelemetry concept that is natively
represented in OTLP, but does not have an equivalent in other telemetry formats
and protocols.
Any additions to the `otel.*` namespace MUST be approved as part of
OpenTelemetry specification.