Skip to content

Commit

Permalink
Require that names and namespaces are one global space across all sem…
Browse files Browse the repository at this point in the history
…antic convention areas (open-telemetry#832)

* Require that names and namespaces are one global space across all semantic convention areas

We have semantic conventions for Resources, Spans and Metrics (in the future also Logs are expected).
It was not clear if the attribute names across all convention areas should be globally unique.

This commit asserts that conventions are one space, they are not independent spaces with
their own namespaces each.

We prohibit using the same Span or Resource attribute name or metric label name but give them
slightly different meanings or value sets.

Resolves: open-telemetry/opentelemetry-specification#815

* Address PR comments

Co-authored-by: Bogdan Drutu <bogdandrutu@gmail.com>
  • Loading branch information
2 people authored and jack-berg committed Nov 16, 2023
1 parent 3a85553 commit 75186f6
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions specification/common/common.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,15 @@ Names SHOULD follow these rules:
- When a new namespace is necessary consider whether it should be a top-level
namespace (e.g. `service`) or a nested namespace (e.g. `service.instance`).

- Semantic conventions exist for four areas: for Resource, Span and Log
attribute names as well as Metric label keys. In addition, for spans we have
two more areas: Event and Link attribute names. Identical namespaces or names
in all these areas MUST have identical meanings. For example the `http.method`
span attribute name denotes exactly the same concept as the `http.method`
metric label, has the same data type and the same set of possible values (in
both cases it records the value of the HTTP protocol's request method as a
string).

- Semantic conventions MUST 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)
Expand Down

0 comments on commit 75186f6

Please sign in to comment.