Skip to content

Commit 5ad8cfb

Browse files
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.
1 parent 9a7f4f7 commit 5ad8cfb

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ release.
2525
- Fix the inconsistent formatting of semantic convention enums ([#1598](https://github.com/open-telemetry/opentelemetry-specification/pull/1598/))
2626
- Add details for filling resource for AWS Lambda([#1610](https://github.com/open-telemetry/opentelemetry-specification/pull/1610))
2727
- Add already specified `messaging.rabbitmq.routing_key` span attribute key to the respective YAML file.
28+
- Clarify usage of "otel." attribute namespace ([#1640](https://github.com/open-telemetry/opentelemetry-specification/pull/1640)).
2829

2930
### Compatibility
3031

specification/common/attribute-and-label-naming.md

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

0 commit comments

Comments
 (0)