Skip to content

Commit b42dfbd

Browse files
authored
Update hardware group name to match metric_name (#1457)
1 parent 8d2ab74 commit b42dfbd

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

docs/hardware/common.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The below metrics apply to any type of hardware component.
2626

2727
These common `hw.` metrics include the below attributes to describe the
2828
monitored component:
29-
<!-- semconv metric.hardware.attributes -->
29+
<!-- semconv metric.hw.attributes -->
3030
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
3131
<!-- see templates/registry/markdown/snippet.md.j2 -->
3232
<!-- prettier-ignore-start -->
@@ -74,7 +74,7 @@ monitored component:
7474

7575
This metric is [recommended][MetricRecommended].
7676

77-
<!-- semconv metric.hardware.energy -->
77+
<!-- semconv metric.hw.energy -->
7878
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
7979
<!-- see templates/registry/markdown/snippet.md.j2 -->
8080
<!-- prettier-ignore-start -->
@@ -126,7 +126,7 @@ This metric is [recommended][MetricRecommended].
126126

127127
This metric is [recommended][MetricRecommended].
128128

129-
<!-- semconv metric.hardware.errors -->
129+
<!-- semconv metric.hw.errors -->
130130
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
131131
<!-- see templates/registry/markdown/snippet.md.j2 -->
132132
<!-- prettier-ignore-start -->
@@ -188,7 +188,7 @@ This metric is [recommended][MetricRecommended].
188188

189189
This metric is [recommended][MetricRecommended].
190190

191-
<!-- semconv metric.hardware.power -->
191+
<!-- semconv metric.hw.power -->
192192
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
193193
<!-- see templates/registry/markdown/snippet.md.j2 -->
194194
<!-- prettier-ignore-start -->
@@ -244,7 +244,7 @@ This metric is [recommended][MetricRecommended].
244244

245245
This metric is [recommended][MetricRecommended].
246246

247-
<!-- semconv metric.hardware.status -->
247+
<!-- semconv metric.hw.status -->
248248
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
249249
<!-- see templates/registry/markdown/snippet.md.j2 -->
250250
<!-- prettier-ignore-start -->

model/hardware/common-metrics.yaml

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
groups:
22
# COMMON METRICS
3-
- id: metric.hardware.attributes
3+
- id: metric.hw.attributes
44
type: attribute_group
55
brief: "Attributes for hardware metrics"
66
extends: hardware.attributes.common
77
attributes:
88
- ref: hw.type
99
requirement_level: required
1010

11-
- id: metric.hardware.energy
11+
- id: metric.hw.energy
1212
type: metric
1313
metric_name: hw.energy
1414
stability: experimental
1515
brief: "Energy consumed by the component"
1616
instrument: counter
1717
unit: "J"
18-
extends: metric.hardware.attributes
18+
extends: metric.hw.attributes
1919

20-
- id: metric.hardware.errors
20+
- id: metric.hw.errors
2121
type: metric
2222
metric_name: hw.errors
2323
stability: experimental
2424
brief: "Number of errors encountered by the component"
2525
instrument: counter
2626
unit: "{error}"
27-
extends: metric.hardware.attributes
27+
extends: metric.hw.attributes
2828
attributes:
2929
- ref: error.type
3030
brief: "The type of error encountered by the component"
@@ -35,7 +35,7 @@ groups:
3535
The `error.type` SHOULD match the error code reported by the component, the canonical name of the error,
3636
or another low-cardinality error identifier. Instrumentations SHOULD document the list of errors they report.
3737
38-
- id: metric.hardware.power
38+
- id: metric.hw.power
3939
type: metric
4040
metric_name: hw.power
4141
stability: experimental
@@ -44,16 +44,16 @@ groups:
4444
It is recommended to report `hw.energy` instead of `hw.power` when possible.
4545
instrument: gauge
4646
unit: "W"
47-
extends: metric.hardware.attributes
47+
extends: metric.hw.attributes
4848

49-
- id: metric.hardware.status
49+
- id: metric.hw.status
5050
type: metric
5151
metric_name: hw.status
5252
stability: experimental
5353
brief: "Operational status: `1` (true) or `0` (false) for each of the possible states"
5454
instrument: updowncounter
5555
unit: "1"
56-
extends: metric.hardware.attributes
56+
extends: metric.hw.attributes
5757
note: >
5858
`hw.status` is currently specified as an *UpDownCounter* but would ideally be represented using a
5959
[*StateSet* as defined in OpenMetrics](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#stateset).

0 commit comments

Comments
 (0)