この記事は英語の原文を日本語に翻訳したものです。原文: https://opentelemetry.io/docs/specs/semconv/hardware/network/
翻訳元: open-telemetry/semantic-conventions v1.44.0（コミット e10a930）
ネットワークメトリクスに関するセマンティック規約
ステータス: Development
ネットワークメトリクス hw.network.*
物理ネットワークインターフェース、またはネットワークインターフェースコントローラー（NIC）。ソフトウェアベースの仮想アダプターやループバックは除きます。例えば、サーバー・スイッチ・ルーター・ファイアウォール上の物理ネットワークインターフェース、HBA、ファイバーチャネルポート、Wi-Fiアダプターなどです。
メトリクス: hw.errors（ネットワーク）
このメトリクスは推奨（recommended）です。
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
hw.errors | Counter | {error} | ネットワークアダプターで発生したエラーの数。 |  |
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
hw.id | | Required | string | 監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子 | win32battery_battery_testsysa33_1 |
hw.type | | Required | string | コンポーネントの種別 [1] | network |
error.type |  | Conditionally Required if and only if an error has occurred | string | コンポーネントで発生したエラーの種別。 [2] | uncorrected; zero_buffer_credit; crc; bad_sector |
hw.model | | Recommended | string | ハードウェアコンポーネントを説明するモデル名 | PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery |
hw.name | | Recommended | string | ハードウェアコンポーネントの、見てすぐわかる名前 | eth0 |
hw.network.logical_addresses | | Recommended | string[] | アダプターの論理アドレス（例：IPアドレス、またはWWPN） | ["172.16.8.21", "57.11.193.42"] |
hw.network.physical_address | | Recommended | string | アダプターの物理アドレス（例：MACアドレス、またはWWNN） | 00-90-F5-E9-7B-36 |
hw.parent | | Recommended | string | 親コンポーネントの一意識別子（通常はエンクロージャーまたはディスクコントローラーのhw.id属性） | dellStorage_perc_0 |
hw.serial_number | | Recommended | string | ハードウェアコンポーネントのシリアル番号 | CNFCP0123456789 |
hw.vendor | | Recommended | string | ハードウェアコンポーネントのベンダー名 | Dell; HP; Intel; AMD; LSI; Lenovo |
network.io.direction |  | Recommended | string | 観測対象ホストの物理または仮想ネットワークインターフェースから見たトラフィックの方向。ステートフルな接続やネットワークフローの論理的な方向を表すために使用すべきではありません（should not）。 | receive; transmit |
[1] hw.type: networkに設定しなければなりません（MUST）。
[2] error.type: error.typeは、コンポーネントが報告するエラーコード、エラーの正式名称、またはそれ以外の低カーディナリティなエラー識別子と一致すべきです（SHOULD）。計装は、報告するエラーの一覧を文書化すべきです（SHOULD）。
error.typeには、以下のよく知られた値のリストがあります。これらのいずれかが該当する場合は、対応する値を使用しなければならず（MUST）、そうでない場合はカスタム値を使用してもよい（MAY）です。
| Value | Description | Stability |
|---|---|---|
_OTHER | 計装がカスタム値を定義していない場合に使用する、フォールバック用のエラー値。 | |
hw.typeには、以下のよく知られた値のリストがあります。これらのいずれかが該当する場合は、対応する値を使用しなければならず（MUST）、そうでない場合はカスタム値を使用してもよい（MAY）です。
| Value | Description | Stability |
|---|---|---|
battery | バッテリー | |
cpu | CPU | |
disk_controller | ディスクコントローラー | |
enclosure | エンクロージャー | |
fan | ファン | |
gpu | GPU | |
logical_disk | 論理ディスク | |
memory | メモリ | |
network | ネットワーク | |
physical_disk | 物理ディスク | |
power_supply | 電源ユニット | |
tape_drive | テープドライブ | |
temperature | 温度 | |
voltage | 電圧 | |
network.io.directionには、以下のよく知られた値のリストがあります。これらのいずれかが該当する場合は、対応する値を使用しなければならず（MUST）、そうでない場合はカスタム値を使用してもよい（MAY）です。
| Value | Description | Stability |
|---|---|---|
receive | receive（受信） | |
transmit | transmit（送信） | |
メトリクス: hw.network.bandwidth.limit
このメトリクスは推奨（recommended）です。
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
hw.network.bandwidth.limit | UpDownCounter | By/s | リンク速度。 | |
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
hw.id | | Required | string | 監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子 | win32battery_battery_testsysa33_1 |
hw.model | | Recommended | string | ハードウェアコンポーネントを説明するモデル名 | PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery |
hw.name | | Recommended | string | ハードウェアコンポーネントの、見てすぐわかる名前 | eth0 |
hw.network.logical_addresses | | Recommended | string[] | アダプターの論理アドレス（例：IPアドレス、またはWWPN） | ["172.16.8.21", "57.11.193.42"] |
hw.network.physical_address | | Recommended | string | アダプターの物理アドレス（例：MACアドレス、またはWWNN） | 00-90-F5-E9-7B-36 |
hw.parent | | Recommended | string | 親コンポーネントの一意識別子（通常はエンクロージャーまたはディスクコントローラーのhw.id属性） | dellStorage_perc_0 |
hw.serial_number | | Recommended | string | ハードウェアコンポーネントのシリアル番号 | CNFCP0123456789 |
hw.vendor | | Recommended | string | ハードウェアコンポーネントのベンダー名 | Dell; HP; Intel; AMD; LSI; Lenovo |
メトリクス: hw.network.bandwidth.utilization
このメトリクスは推奨（recommended）です。
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
hw.network.bandwidth.utilization | Gauge | 1 | ネットワーク帯域幅の使用率。 | |
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
hw.id | | Required | string | 監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子 | win32battery_battery_testsysa33_1 |
hw.model | | Recommended | string | ハードウェアコンポーネントを説明するモデル名 | PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery |
hw.name | | Recommended | string | ハードウェアコンポーネントの、見てすぐわかる名前 | eth0 |
hw.network.logical_addresses | | Recommended | string[] | アダプターの論理アドレス（例：IPアドレス、またはWWPN） | ["172.16.8.21", "57.11.193.42"] |
hw.network.physical_address | | Recommended | string | アダプターの物理アドレス（例：MACアドレス、またはWWNN） | 00-90-F5-E9-7B-36 |
hw.parent | | Recommended | string | 親コンポーネントの一意識別子（通常はエンクロージャーまたはディスクコントローラーのhw.id属性） | dellStorage_perc_0 |
hw.serial_number | | Recommended | string | ハードウェアコンポーネントのシリアル番号 | CNFCP0123456789 |
hw.vendor | | Recommended | string | ハードウェアコンポーネントのベンダー名 | Dell; HP; Intel; AMD; LSI; Lenovo |
メトリクス: hw.network.io
このメトリクスは推奨（recommended）です。
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
hw.network.io | Counter | By | 送受信したネットワークトラフィック（バイト単位）。 | |
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
hw.id | | Required | string | 監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子 | win32battery_battery_testsysa33_1 |
network.io.direction | | Required | string | 観測対象ホストの物理または仮想ネットワークインターフェースから見たトラフィックの方向。ステートフルな接続やネットワークフローの論理的な方向を表すために使用すべきではありません（should not）。 | receive; transmit |
hw.model | | Recommended | string | ハードウェアコンポーネントを説明するモデル名 | PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery |
hw.name | | Recommended | string | ハードウェアコンポーネントの、見てすぐわかる名前 | eth0 |
hw.network.logical_addresses | | Recommended | string[] | アダプターの論理アドレス（例：IPアドレス、またはWWPN） | ["172.16.8.21", "57.11.193.42"] |
hw.network.physical_address | | Recommended | string | アダプターの物理アドレス（例：MACアドレス、またはWWNN） | 00-90-F5-E9-7B-36 |
hw.parent | | Recommended | string | 親コンポーネントの一意識別子（通常はエンクロージャーまたはディスクコントローラーのhw.id属性） | dellStorage_perc_0 |
hw.serial_number | | Recommended | string | ハードウェアコンポーネントのシリアル番号 | CNFCP0123456789 |
hw.vendor | | Recommended | string | ハードウェアコンポーネントのベンダー名 | Dell; HP; Intel; AMD; LSI; Lenovo |
network.io.directionには、以下のよく知られた値のリストがあります。これらのいずれかが該当する場合は、対応する値を使用しなければならず（MUST）、そうでない場合はカスタム値を使用してもよい（MAY）です。
| Value | Description | Stability |
|---|---|---|
receive | receive（受信） | |
transmit | transmit（送信） | |
メトリクス: hw.network.packets
このメトリクスは推奨（recommended）です。
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
hw.network.packets | Counter | {packet} | 送受信したネットワークトラフィック（パケットまたはフレーム単位）。 | |
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
hw.id | | Required | string | 監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子 | win32battery_battery_testsysa33_1 |
network.io.direction | | Required | string | 観測対象ホストの物理または仮想ネットワークインターフェースから見たトラフィックの方向。ステートフルな接続やネットワークフローの論理的な方向を表すために使用すべきではありません（should not）。 | receive; transmit |
hw.model | | Recommended | string | ハードウェアコンポーネントを説明するモデル名 | PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery |
hw.name | | Recommended | string | ハードウェアコンポーネントの、見てすぐわかる名前 | eth0 |
hw.network.logical_addresses | | Recommended | string[] | アダプターの論理アドレス（例：IPアドレス、またはWWPN） | ["172.16.8.21", "57.11.193.42"] |
hw.network.physical_address | | Recommended | string | アダプターの物理アドレス（例：MACアドレス、またはWWNN） | 00-90-F5-E9-7B-36 |
hw.parent | | Recommended | string | 親コンポーネントの一意識別子（通常はエンクロージャーまたはディスクコントローラーのhw.id属性） | dellStorage_perc_0 |
hw.serial_number | | Recommended | string | ハードウェアコンポーネントのシリアル番号 | CNFCP0123456789 |
hw.vendor | | Recommended | string | ハードウェアコンポーネントのベンダー名 | Dell; HP; Intel; AMD; LSI; Lenovo |
network.io.directionには、以下のよく知られた値のリストがあります。これらのいずれかが該当する場合は、対応する値を使用しなければならず（MUST）、そうでない場合はカスタム値を使用してもよい（MAY）です。
| Value | Description | Stability |
|---|---|---|
receive | receive（受信） | |
transmit | transmit（送信） | |
メトリクス: hw.network.up
このメトリクスは推奨（recommended）です。
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
hw.network.up | UpDownCounter | 1 | リンクの状態：1（up）または0（down）。 | |
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
hw.id | | Required | string | 監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子 | win32battery_battery_testsysa33_1 |
hw.model | | Recommended | string | ハードウェアコンポーネントを説明するモデル名 | PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery |
hw.name | | Recommended | string | ハードウェアコンポーネントの、見てすぐわかる名前 | eth0 |
hw.network.logical_addresses | | Recommended | string[] | アダプターの論理アドレス（例：IPアドレス、またはWWPN） | ["172.16.8.21", "57.11.193.42"] |
hw.network.physical_address | | Recommended | string | アダプターの物理アドレス（例：MACアドレス、またはWWNN） | 00-90-F5-E9-7B-36 |
hw.parent | | Recommended | string | 親コンポーネントの一意識別子（通常はエンクロージャーまたはディスクコントローラーのhw.id属性） | dellStorage_perc_0 |
hw.serial_number | | Recommended | string | ハードウェアコンポーネントのシリアル番号 | CNFCP0123456789 |
hw.vendor | | Recommended | string | ハードウェアコンポーネントのベンダー名 | Dell; HP; Intel; AMD; LSI; Lenovo |
メトリクス: hw.status（ネットワーク）
このメトリクスは推奨（recommended）です。
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
|---|---|---|---|---|---|
hw.status | UpDownCounter | 1 | 動作ステータス：可能な各状態に対して1（true）または0（false）。 [1] | |
[1]: hw.statusは現在UpDownCounterとして規定されていますが、理想的にはOpenMetricsで定義されているStateSetを使って表現されるべきです。StateSetがOpenTelemetryで規定された時点で、このセマンティック規約は更新されます。この予定されている変更は、ユーザーが時系列バックエンドに対してhw.statusの値を時系列で取得する方法に影響を与えることは想定されていません。
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
hw.id | | Required | string | 監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子 | win32battery_battery_testsysa33_1 |
hw.state | | Required | string | コンポーネントの現在の状態 [1] | ok; degraded; failed |
hw.type | | Required | string | コンポーネントの種別 [2] | network |
hw.model | | Recommended | string | ハードウェアコンポーネントを説明するモデル名 | PERC H740P; Intel(R) Core(TM) i7-10700K; Dell XPS 15 Battery |
hw.name | | Recommended | string | ハードウェアコンポーネントの、見てすぐわかる名前 | eth0 |
hw.network.logical_addresses | | Recommended | string[] | アダプターの論理アドレス（例：IPアドレス、またはWWPN） | ["172.16.8.21", "57.11.193.42"] |
hw.network.physical_address | | Recommended | string | アダプターの物理アドレス（例：MACアドレス、またはWWNN） | 00-90-F5-E9-7B-36 |
hw.parent | | Recommended | string | 親コンポーネントの一意識別子（通常はエンクロージャーまたはディスクコントローラーのhw.id属性） | dellStorage_perc_0 |
hw.serial_number | | Recommended | string | ハードウェアコンポーネントのシリアル番号 | CNFCP0123456789 |
hw.vendor | | Recommended | string | ハードウェアコンポーネントのベンダー名 | Dell; HP; Intel; AMD; LSI; Lenovo |
[1] hw.state: 以下のいずれかの値に設定しなければなりません（MUST）。
ok：ネットワークアダプターは正常に動作しています。degraded：ネットワークアダプターは機能または性能が低下した状態で動作しています。failed：ネットワークアダプターは故障し、動作していません。
[2] hw.type: networkに設定しなければなりません（MUST）。
hw.stateには、以下のよく知られた値のリストがあります。これらのいずれかが該当する場合は、対応する値を使用しなければならず（MUST）、そうでない場合はカスタム値を使用してもよい（MAY）です。
| Value | Description | Stability |
|---|---|---|
degraded | Degraded（劣化） | |
failed | Failed（故障） | |
needs_cleaning | Needs Cleaning（清掃が必要） | |
ok | OK（正常） | |
predicted_failure | Predicted Failure（故障予測） | |
hw.typeには、以下のよく知られた値のリストがあります。これらのいずれかが該当する場合は、対応する値を使用しなければならず（MUST）、そうでない場合はカスタム値を使用してもよい（MAY）です。
| Value | Description | Stability |
|---|---|---|
battery | バッテリー | |
cpu | CPU | |
disk_controller | ディスクコントローラー | |
enclosure | エンクロージャー | |
fan | ファン | |
gpu | GPU | |
logical_disk | 論理ディスク | |
memory | メモリ | |
network | ネットワーク | |
physical_disk | 物理ディスク | |
power_supply | 電源ユニット | |
tape_drive | テープドライブ | |
temperature | 温度 | |
voltage | 電圧 | |