メモリメトリクスに関するセマンティック規約

ステータス: Development

メモリメトリクス `hw.memory.*`

コンピューターシステム内のメモリモジュール。

メトリクス: `hw.errors`（メモリ）

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]	`memory`
`error.type`	`Conditionally Required` if and only if an error has occurred	string	コンポーネントで発生したエラーの種別。 [2]	`uncorrected`; `zero_buffer_credit`; `crc`; `bad_sector`
`hw.memory.type`	`Recommended`	string	メモリモジュールの種別	`DDR4`; `DDR5`; `LPDDR5`
`hw.model`	`Recommended`	string	ハードウェアコンポーネントを説明するモデル名	`PERC H740P`; `Intel(R) Core(TM) i7-10700K`; `Dell XPS 15 Battery`
`hw.name`	`Recommended`	string	ハードウェアコンポーネントの、見てすぐわかる名前	`eth0`
`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.type: memoryに設定しなければなりません（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`	電圧

メトリクス: `hw.memory.size`

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

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
`hw.memory.size`	UpDownCounter	`By`	メモリモジュールのサイズ。

Attributes:

Key	Requirement Level	Value Type	Description	Example Values
`hw.id`	`Required`	string	監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子	`win32battery_battery_testsysa33_1`
`hw.memory.type`	`Recommended`	string	メモリモジュールの種別	`DDR4`; `DDR5`; `LPDDR5`
`hw.model`	`Recommended`	string	ハードウェアコンポーネントを説明するモデル名	`PERC H740P`; `Intel(R) Core(TM) i7-10700K`; `Dell XPS 15 Battery`
`hw.name`	`Recommended`	string	ハードウェアコンポーネントの、見てすぐわかる名前	`eth0`
`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	Requirement Level	Value Type	Description	Example Values
`hw.id`	`Required`	string	監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子	`win32battery_battery_testsysa33_1`
`hw.state`	`Required`	string	コンポーネントの現在の状態 [1]	`ok`; `degraded`; `failed`; `predicted_failure`
`hw.type`	`Required`	string	コンポーネントの種別 [2]	`memory`
`hw.memory.type`	`Recommended`	string	メモリモジュールの種別	`DDR4`; `DDR5`; `LPDDR5`
`hw.model`	`Recommended`	string	ハードウェアコンポーネントを説明するモデル名	`PERC H740P`; `Intel(R) Core(TM) i7-10700K`; `Dell XPS 15 Battery`
`hw.name`	`Recommended`	string	ハードウェアコンポーネントの、見てすぐわかる名前	`eth0`
`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：メモリモジュールは故障し、動作していません。
predicted_failure：メモリモジュールは現在動作していますが、近いうちに故障すると予測されています。

[2] hw.type: memoryに設定しなければなりません（MUST）。

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

メモリメトリクスに関するセマンティック規約

メモリメトリクス hw.memory.*

メトリクス: hw.errors（メモリ）

メトリクス: hw.memory.size

メトリクス: hw.status（メモリ）

メモリメトリクス `hw.memory.*`

メトリクス: `hw.errors`（メモリ）

メトリクス: `hw.memory.size`

メトリクス: `hw.status`（メモリ）