Skip to content

Commit

Permalink
Add a warning to the system semantic conventions
Browse files Browse the repository at this point in the history
Add a warning the system semantic conventions to prevent implementations from adopting the breaking changes until the conventions are stabilized. This warning is to be updated once open-telemetry#246 is closed
  • Loading branch information
dmitryax committed Dec 7, 2023
1 parent eff3086 commit 3e13b40
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/system/hardware-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@ when creating instruments not explicitly defined in the specification.

<!-- tocstop -->

> **Warning**
> Existing instrumentations and collector that are using
> [v1.21.0 of this document](/../v1.21.0/docs/system/hardware-metrics.md)
> (or prior):
>
> * SHOULD NOT adopt any breaking changes from document until the system
> semantic conventions are marked stable. Conventions include, but are not
> limited to, attributes, metric names, and unit of measure.
> * SHOULD introduce a control mechanism to allow users to opt-in to the new
> conventions once the migration plan is finalized.
## Common hardware attributes

All metrics in `hw.` instruments should be attached to a [Host Resource](/docs/resource/host.md)
Expand Down
10 changes: 10 additions & 0 deletions docs/system/process-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@ metrics](/docs/runtime/README.md#metrics).

<!-- tocstop -->

> **Warning** Existing instrumentations and collector that are using
> [v1.21.0 of this document](/../v1.21.0/docs/system/process-metrics.md)
> (or prior):
>
> * SHOULD NOT adopt any breaking changes from document until the system
> semantic conventions are marked stable. Conventions include, but are not
> limited to, attributes, metric names, and unit of measure.
> * SHOULD introduce a control mechanism to allow users to opt-in to the new
> conventions once the migration plan is finalized.
## Metric Instruments

### Process
Expand Down
10 changes: 10 additions & 0 deletions docs/system/system-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,16 @@ Resource attributes related to a host, SHOULD be reported under the `host.*` nam

<!-- tocstop -->

> **Warning** Existing instrumentations and collector that are using
> [v1.21.0 of this document](/../v1.21.0/docs/system/system-metrics.md)
> (or prior):
>
> * SHOULD NOT adopt any breaking changes from document until the system
> semantic conventions are marked stable. Conventions include, but are not
> limited to, attributes, metric names, and unit of measure.
> * SHOULD introduce a control mechanism to allow users to opt-in to the new
> conventions once the migration plan is finalized.
## Processor Metrics

**Description:** System level processor metrics captured under the namespace `system.cpu`.
Expand Down

0 comments on commit 3e13b40

Please sign in to comment.