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

Update hardware group name to match metric_name (#1457)

This commit is contained in:
Liudmila Molkova 2024-10-07 13:51:58 -07:00 committed by GitHub
parent 8d2ab74d40
commit b42dfbd73e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/hardware/common.md
View File

@ -26,7 +26,7 @@ The below metrics apply to any type of hardware component.
These common `hw.` metrics include the below attributes to describe the These common `hw.` metrics include the below attributes to describe the
monitored component: monitored component:
<!-- semconv metric.hardware.attributes --> <!-- semconv metric.hw.attributes -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 --> <!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start --> <!-- prettier-ignore-start -->
@ -74,7 +74,7 @@ monitored component:
This metric is [recommended][MetricRecommended]. This metric is [recommended][MetricRecommended].
<!-- semconv metric.hardware.energy --> <!-- semconv metric.hw.energy -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 --> <!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start --> <!-- prettier-ignore-start -->
@ -126,7 +126,7 @@ This metric is [recommended][MetricRecommended].
This metric is [recommended][MetricRecommended]. This metric is [recommended][MetricRecommended].
<!-- semconv metric.hardware.errors --> <!-- semconv metric.hw.errors -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 --> <!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start --> <!-- prettier-ignore-start -->
@ -188,7 +188,7 @@ This metric is [recommended][MetricRecommended].
This metric is [recommended][MetricRecommended]. This metric is [recommended][MetricRecommended].
<!-- semconv metric.hardware.power --> <!-- semconv metric.hw.power -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 --> <!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start --> <!-- prettier-ignore-start -->
@ -244,7 +244,7 @@ This metric is [recommended][MetricRecommended].
This metric is [recommended][MetricRecommended]. This metric is [recommended][MetricRecommended].
<!-- semconv metric.hardware.status --> <!-- semconv metric.hw.status -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 --> <!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start --> <!-- prettier-ignore-start -->

18
model/hardware/common-metrics.yaml
View File

@ -1,6 +1,6 @@
groups: groups:
# COMMON METRICS # COMMON METRICS
- id: metric.hardware.attributes - id: metric.hw.attributes
type: attribute_group type: attribute_group
brief: "Attributes for hardware metrics" brief: "Attributes for hardware metrics"
extends: hardware.attributes.common extends: hardware.attributes.common
@ -8,23 +8,23 @@ groups:
- ref: hw.type - ref: hw.type
requirement_level: required requirement_level: required
- id: metric.hardware.energy - id: metric.hw.energy
type: metric type: metric
metric_name: hw.energy metric_name: hw.energy
stability: experimental stability: experimental
brief: "Energy consumed by the component" brief: "Energy consumed by the component"
instrument: counter instrument: counter
unit: "J" unit: "J"
extends: metric.hardware.attributes extends: metric.hw.attributes
- id: metric.hardware.errors - id: metric.hw.errors
type: metric type: metric
metric_name: hw.errors metric_name: hw.errors
stability: experimental stability: experimental
brief: "Number of errors encountered by the component" brief: "Number of errors encountered by the component"
instrument: counter instrument: counter
unit: "{error}" unit: "{error}"
extends: metric.hardware.attributes extends: metric.hw.attributes
attributes: attributes:
- ref: error.type - ref: error.type
brief: "The type of error encountered by the component" brief: "The type of error encountered by the component"
@ -35,7 +35,7 @@ groups:
The `error.type` SHOULD match the error code reported by the component, the canonical name of the error, The `error.type` SHOULD match the error code reported by the component, the canonical name of the error,
or another low-cardinality error identifier. Instrumentations SHOULD document the list of errors they report. or another low-cardinality error identifier. Instrumentations SHOULD document the list of errors they report.
- id: metric.hardware.power - id: metric.hw.power
type: metric type: metric
metric_name: hw.power metric_name: hw.power
stability: experimental stability: experimental
@ -44,16 +44,16 @@ groups:
It is recommended to report `hw.energy` instead of `hw.power` when possible. It is recommended to report `hw.energy` instead of `hw.power` when possible.
instrument: gauge instrument: gauge
unit: "W" unit: "W"
extends: metric.hardware.attributes extends: metric.hw.attributes
- id: metric.hardware.status - id: metric.hw.status
type: metric type: metric
metric_name: hw.status metric_name: hw.status
stability: experimental stability: experimental
brief: "Operational status: `1` (true) or `0` (false) for each of the possible states" brief: "Operational status: `1` (true) or `0` (false) for each of the possible states"
instrument: updowncounter instrument: updowncounter
unit: "1" unit: "1"
extends: metric.hardware.attributes extends: metric.hw.attributes
note: > note: >
`hw.status` is currently specified as an *UpDownCounter* but would ideally be represented using a `hw.status` is currently specified as an *UpDownCounter* but would ideally be represented using a
[*StateSet* as defined in OpenMetrics](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#stateset). [*StateSet* as defined in OpenMetrics](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#stateset).