共通ハードウェアメトリクスに関するセマンティック規約

ステータス: Development

ハードウェアメトリクスには、それが報告される対象のデバイス、マシン、ホストを識別する属性は含まれません。この情報は、ユーザーアプリケーションが設定するリソース属性を通じて提供されることが期待されます。アプリケーション開発者は、Hostリソース属性を設定することが推奨されます。

共通ハードウェアメトリクス

以下のメトリクスは、いかなる種類のハードウェアコンポーネントにも適用されます。

メトリクス: `hw.energy`

このメトリクスは推奨（recommended）です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
`hw.energy`	Counter	`J`	コンポーネントが消費したエネルギー。

Attributes:

Key	Requirement Level	Value Type	Description	Example Values
`hw.id`	`Required`	string	監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子	`win32battery_battery_testsysa33_1`
`hw.type`	`Required`	string	コンポーネントの種別 [1]	`battery`; `cpu`; `disk_controller`
`hw.name`	`Recommended`	string	ハードウェアコンポーネントの、見てすぐわかる名前	`eth0`
`hw.parent`	`Recommended`	string	親コンポーネントの一意識別子（通常はエンクロージャーまたはディスクコントローラーの`hw.id`属性）	`dellStorage_perc_0`

[1] hw.type: hw.stateが報告される対象のハードウェアコンポーネントの分類を記述します。例えばhw.type=temperatureとhw.state=degradedが組み合わさっている場合、そのハードウェアコンポーネントの温度がdegradedとして報告されたことを示します。

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`	電圧

メトリクス: `hw.errors`

このメトリクスは推奨（recommended）です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
`hw.errors`	Counter	`{error}`	コンポーネントで発生したエラーの数。

Attributes:

Key	Requirement Level	Value Type	Description	Example Values
`hw.id`	`Required`	string	監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子	`win32battery_battery_testsysa33_1`
`hw.type`	`Required`	string	コンポーネントの種別 [1]	`battery`; `cpu`; `disk_controller`
`error.type`	`Conditionally Required` if and only if an error has occurred	string	コンポーネントで発生したエラーの種別。 [2]	`uncorrected`; `zero_buffer_credit`; `crc`; `bad_sector`
`hw.name`	`Recommended`	string	ハードウェアコンポーネントの、見てすぐわかる名前	`eth0`
`hw.parent`	`Recommended`	string	親コンポーネントの一意識別子（通常はエンクロージャーまたはディスクコントローラーの`hw.id`属性）	`dellStorage_perc_0`

[2] error.type: error.typeは、コンポーネントが報告するエラーコード、エラーの正式名称、またはそれ以外の低カーディナリティなエラー識別子と一致すべきです（SHOULD）。計装は、報告するエラーの一覧を文書化すべきです（SHOULD）。

error.typeには、以下のよく知られた値のリストがあります。これらのいずれかが該当する場合は、対応する値を使用しなければならず（MUST）、そうでない場合はカスタム値を使用してもよい（MAY）です。

Value	Description	Stability
`_OTHER`	計装がカスタム値を定義していない場合に使用する、フォールバック用のエラー値。

Value	Description	Stability
`battery`	バッテリー
`cpu`	CPU
`disk_controller`	ディスクコントローラー
`enclosure`	エンクロージャー
`fan`	ファン
`gpu`	GPU
`logical_disk`	論理ディスク
`memory`	メモリ
`network`	ネットワーク
`physical_disk`	物理ディスク
`power_supply`	電源ユニット
`tape_drive`	テープドライブ
`temperature`	温度
`voltage`	電圧

メトリクス: `hw.power`

このメトリクスは推奨（recommended）です。

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
`hw.power`	Gauge	`W`	コンポーネントが消費している瞬時電力。 [1]

[1]: 可能な場合は、hw.powerではなくhw.energyを報告することが推奨されます。

Attributes:

Key	Requirement Level	Value Type	Description	Example Values
`hw.id`	`Required`	string	監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子	`win32battery_battery_testsysa33_1`
`hw.type`	`Required`	string	コンポーネントの種別 [1]	`battery`; `cpu`; `disk_controller`
`hw.name`	`Recommended`	string	ハードウェアコンポーネントの、見てすぐわかる名前	`eth0`
`hw.parent`	`Recommended`	string	親コンポーネントの一意識別子（通常はエンクロージャーまたはディスクコントローラーの`hw.id`属性）	`dellStorage_perc_0`

Value	Description	Stability
`battery`	バッテリー
`cpu`	CPU
`disk_controller`	ディスクコントローラー
`enclosure`	エンクロージャー
`fan`	ファン
`gpu`	GPU
`logical_disk`	論理ディスク
`memory`	メモリ
`network`	ネットワーク
`physical_disk`	物理ディスク
`power_supply`	電源ユニット
`tape_drive`	テープドライブ
`temperature`	温度
`voltage`	電圧

メトリクス: `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	Requirement Level	Value Type	Description	Example Values
`hw.id`	`Required`	string	監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子	`win32battery_battery_testsysa33_1`
`hw.state`	`Required`	string	コンポーネントの現在の状態	`degraded`; `failed`; `needs_cleaning`
`hw.type`	`Required`	string	コンポーネントの種別 [1]	`battery`; `cpu`; `disk_controller`
`hw.name`	`Recommended`	string	ハードウェアコンポーネントの、見てすぐわかる名前	`eth0`
`hw.parent`	`Recommended`	string	親コンポーネントの一意識別子（通常はエンクロージャーまたはディスクコントローラーの`hw.id`属性）	`dellStorage_perc_0`

hw.stateには、以下のよく知られた値のリストがあります。これらのいずれかが該当する場合は、対応する値を使用しなければならず（MUST）、そうでない場合はカスタム値を使用してもよい（MAY）です。

Value	Description	Stability
`degraded`	Degraded（劣化）
`failed`	Failed（故障）
`needs_cleaning`	Needs Cleaning（清掃が必要）
`ok`	OK（正常）
`predicted_failure`	Predicted Failure（故障予測）

Value	Description	Stability
`battery`	バッテリー
`cpu`	CPU
`disk_controller`	ディスクコントローラー
`enclosure`	エンクロージャー
`fan`	ファン
`gpu`	GPU
`logical_disk`	論理ディスク
`memory`	メモリ
`network`	ネットワーク
`physical_disk`	物理ディスク
`power_supply`	電源ユニット
`tape_drive`	テープドライブ
`temperature`	温度
`voltage`	電圧

共通ハードウェアメトリクスに関するセマンティック規約