open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add a warning to the system semantic conventions (#579)

This commit is contained in:
Dmitrii Anoshin 2024-01-08 14:31:40 -08:00 committed by GitHub
parent 1dd4fe3439
commit 75f9d428a4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/system/hardware-metrics.md
View File

@ -33,6 +33,17 @@ when creating instruments not explicitly defined in the specification.
<!-- tocstop -->
> **Warning**
> Existing instrumentations and collector that are using<!-- markdown-link-check-disable-next-line -->
> [v1.21.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/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)

10
docs/system/process-metrics.md
View File

@ -25,6 +25,16 @@ metrics](/docs/runtime/README.md#metrics).
<!-- tocstop -->
> **Warning** Existing instrumentations and collector that are using<!-- markdown-link-check-disable-next-line -->
> [v1.21.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/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

10
docs/system/system-metrics.md
View File

@ -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<!-- markdown-link-check-disable-next-line -->
> [v1.21.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/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`.