Skip to content

Commit

Permalink
Clarification: metric namespaces are not allowed to be metric names
Browse files Browse the repository at this point in the history
  • Loading branch information
trask committed May 5, 2023
1 parent 88e0e7e commit 21aecc4
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ release.
([#3390](https://github.com/open-telemetry/opentelemetry-specification/pull/3390))
- BREAKING: Remove `messaging.consumer.id`, make `messaging.client_id` generic
([#3336](https://github.com/open-telemetry/opentelemetry-specification/pull/3336))
- Clarification: metric namespaces are not allowed to be metric names
([#9999](https://github.com/open-telemetry/opentelemetry-specification/pull/9999))

### Compatibility

Expand Down
8 changes: 8 additions & 0 deletions specification/metrics/semantic_conventions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,14 @@ OpenTelemetry artifacts define the metric structures and hierarchies for some
categories of metrics, and these can assist decisions when creating future
metrics.

Metric names SHOULD NOT coincide with namespaces. For example if
`system.processes.created` is a metric name then it is no longer valid to have
a metric named `system.processes` because `system.processes` is already a
namespace. Because of this rule be careful when choosing names: every existing
name prohibits existence of an equally named namespace in the future, and vice
versa: any existing namespace prohibits existence of an equally named
metric in the future.

Common attributes SHOULD be consistently named. This aids in discoverability and
disambiguates similar attributes to metric names.

Expand Down

0 comments on commit 21aecc4

Please sign in to comment.