diff --git a/CHANGELOG.md b/CHANGELOG.md index 7edbbc3fb8d..10b8c86b5b7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -43,6 +43,8 @@ release. ([#2981](https://github.com/open-telemetry/opentelemetry-specification/pull/2981)) - Add `messaging.kafka.message.offset` attribute. ([#2982](https://github.com/open-telemetry/opentelemetry-specification/pull/2982)) +- Update hardware metrics to use `direction` as per general semantic conventions + ([#2942](https://github.com/open-telemetry/opentelemetry-specification/pull/2942)) ### Compatibility diff --git a/specification/metrics/semantic_conventions/hardware-metrics.md b/specification/metrics/semantic_conventions/hardware-metrics.md index f18a18ce731..289169684d3 100644 --- a/specification/metrics/semantic_conventions/hardware-metrics.md +++ b/specification/metrics/semantic_conventions/hardware-metrics.md @@ -189,19 +189,18 @@ Additional **optional** attributes: **Description:** Graphics Processing Unit (discrete) -| Name | Description | Units | Instrument Type ([*](README.md#instrument-types)) | Value Type | Attribute Key | Attribute Values | -| --------------------------- | ----------------------------------------------------------------------------- | -------- | ------------------------------------------------- | ---------- | -------------------- | ----------------------------------------------- | -| `hw.errors` | Number of errors encountered by the GPU | {errors} | Counter | Int64 | `type` (recommended) | `corrected`, `all` | -| | | | | | `hw.type` (required) | `gpu` | -| `hw.gpu.io.receive` | Received bytes by the GPU | By | Counter | Int64 | | | -| `hw.gpu.io.transmit` | Transmitted bytes by the GPU | By | Counter | Int64 | | | -| `hw.gpu.memory.limit` | Size of the GPU memory | By | UpDownCounter | Int64 | | | -| `hw.gpu.memory.utilization` | Fraction of GPU memory used | 1 | Gauge | Double | | | -| `hw.gpu.memory.usage` | GPU memory used | By | UpDownCounter | Int64 | | | -| `hw.gpu.power` | GPU instantaneous power consumption in Watts | W | Gauge | Double | | | -| `hw.gpu.utilization` | Fraction of time spent in a specific task | 1 | Gauge | Double | `task` (recommended) | `decoder`, `encoder`, `general` | -| `hw.status` | Operational status: `1` (true) or `0` (false) for each of the possible states | | UpDownCounter | Int | `state` (required) | `ok`, `degraded`, `failed`, `predicted_failure` | -| | | | | | `hw.type` (required) | `gpu` | +| Name | Description | Units | Instrument Type ([*](README.md#instrument-types)) | Value Type | Attribute Key | Attribute Values | +| --------------------------- | ----------------------------------------------------------------------------- | -------- | ------------------------------------------------- | ---------- | ---------------------- | ----------------------------------------------- | +| `hw.errors` | Number of errors encountered by the GPU | {errors} | Counter | Int64 | `type` (recommended) | `corrected`, `all` | +| | | | | | `hw.type` (required) | `gpu` | +| `hw.gpu.io` | Received and transmitted bytes by the GPU | By | Counter | Int64 | `direction` (required) | `receive`, `transmit` | +| `hw.gpu.memory.limit` | Size of the GPU memory | By | UpDownCounter | Int64 | | | +| `hw.gpu.memory.utilization` | Fraction of GPU memory used | 1 | Gauge | Double | | | +| `hw.gpu.memory.usage` | GPU memory used | By | UpDownCounter | Int64 | | | +| `hw.gpu.power` | GPU instantaneous power consumption in Watts | W | Gauge | Double | | | +| `hw.gpu.utilization` | Fraction of time spent in a specific task | 1 | Gauge | Double | `task` (recommended) | `decoder`, `encoder`, `general` | +| `hw.status` | Operational status: `1` (true) or `0` (false) for each of the possible states | | UpDownCounter | Int | `state` (required) | `ok`, `degraded`, `failed`, `predicted_failure` | +| | | | | | `hw.type` (required) | `gpu` | Additional **optional** attributes: @@ -260,19 +259,17 @@ Additional **optional** attributes: (NIC), excluding virtual adapters and loopbacks. Examples: an Ethernet adapter, an HBA, an fiber channel port or a Wi-Fi adapter. -| Name | Description | Units | Instrument Type ([*](README.md#instrument-types)) | Value Type | Attribute Key | Attribute Values | -| ---------------------------------- | ------------------------------------------------------------------------------------------------------------ | --------- | ------------------------------------------------- | ---------- | -------------------- | --------------------------- | -| `hw.errors` | Number of errors encountered by the network adapter | {errors} | Counter | Int64 | `type` (recommended) | `all`, `zero_buffer_credit` | -| | | | | | `hw.type` (required) | `network` | -| `hw.network.bandwidth.limit` | Link speed | By | UpDownCounter | Int64 | | | -| `hw.network.bandwidth.utilization` | Utilization of the network bandwidth as a fraction | 1 | Gauge | Double | | | -| `hw.network.io.receive` | Received network traffic in bytes | By | Counter | Int64 | | | -| `hw.network.io.transmit` | Transmitted network traffic in bytes | By | Counter | Int64 | | | -| `hw.network.packets.receive` | Received network traffic in packets (or frames) | {packets} | Counter | Int64 | | | -| `hw.network.packets.transmit` | Transmitted network traffic in packets (or frames) | {packets} | Counter | Int64 | | | -| `hw.network.up` | Link status: `1` (up) or `0` (down) | | UpDownCounter | Int | | | -| `hw.status` | Operational status, regardless of the link status: `1` (true) or `0` (false) for each of the possible states | | UpDownCounter | Int | `state` (required) | `ok`, `degraded`, `failed` | -| | | | | | `hw.type` (required) | `network` | +| Name | Description | Units | Instrument Type ([*](README.md#instrument-types)) | Value Type | Attribute Key | Attribute Values | +| ---------------------------------- | ------------------------------------------------------------------------------------------------------------ | --------- | ------------------------------------------------- | ---------- | ---------------------- | --------------------------- | +| `hw.errors` | Number of errors encountered by the network adapter | {errors} | Counter | Int64 | `type` (recommended) | `all`, `zero_buffer_credit` | +| | | | | | `hw.type` (required) | `network` | +| `hw.network.bandwidth.limit` | Link speed | By | UpDownCounter | Int64 | | | +| `hw.network.bandwidth.utilization` | Utilization of the network bandwidth as a fraction | 1 | Gauge | Double | | | +| `hw.network.io` | Received and transmitted network traffic in bytes | By | Counter | Int64 | `direction` (required) | `receive`, `transmit` | +| `hw.network.packets` | Received and transmitted network traffic in packets (or frames) | {packets} | Counter | Int64 | `direction` (required) | `receive`, `transmit` | +| `hw.network.up` | Link status: `1` (up) or `0` (down) | | UpDownCounter | Int | | | +| `hw.status` | Operational status, regardless of the link status: `1` (true) or `0` (false) for each of the possible states | | UpDownCounter | Int | `state` (required) | `ok`, `degraded`, `failed` | +| | | | | | `hw.type` (required) | `network` | Additional **optional** attributes: