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

ステータス: Development

バッテリーメトリクス `hw.battery.*`

コンピューターシステムまたはUPS内のバッテリー。

メトリクス: `hw.battery.charge`

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
`hw.battery.charge`	Gauge	`1`	バッテリー充電量の残り割合。

Attributes:

Key	Requirement Level	Value Type	Description	Example Values
`hw.id`	`Required`	string	監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子	`win32battery_battery_testsysa33_1`
`hw.battery.capacity`	`Recommended`	string	ワット時またはアンペア時で表した設計容量	`9.3Ah`; `50Wh`
`hw.battery.chemistry`	`Recommended`	string	バッテリーの化学的組成（例：リチウムイオン、ニッケルカドミウムなど）	`Li-ion`; `NiMH`
`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.vendor`	`Recommended`	string	ハードウェアコンポーネントのベンダー名	`Dell`; `HP`; `Intel`; `AMD`; `LSI`; `Lenovo`

メトリクス: `hw.battery.charge.limit`

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

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
`hw.battery.charge.limit`	Gauge	`1`	正常な動作を保証するための、バッテリー充電割合の下限。

Attributes:

Key	Requirement Level	Value Type	Description	Example Values
`hw.id`	`Required`	string	監視対象のホスト内で一意な、ハードウェアコンポーネントの識別子	`win32battery_battery_testsysa33_1`
`hw.battery.capacity`	`Recommended`	string	ワット時またはアンペア時で表した設計容量	`9.3Ah`; `50Wh`
`hw.battery.chemistry`	`Recommended`	string	バッテリーの化学的組成（例：リチウムイオン、ニッケルカドミウムなど）	`Li-ion`; `NiMH`
`hw.limit_type`	`Recommended`	string	デバイスの動作および健全性に関連するバッテリー充電レベルの閾値を表す。各`limit_type`は、最小または最大の最適充電量、シャットダウン閾値、省電力閾値といった特定の充電上限を示す。これらの値は通常、安全かつ効率的なバッテリー使用を導くために、ハードウェアまたはファームウェアから提供される。	`critical`; `throttled`; `degraded`
`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.vendor`	`Recommended`	string	ハードウェアコンポーネントのベンダー名	`Dell`; `HP`; `Intel`; `AMD`; `LSI`; `Lenovo`

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

Value	Description	Stability
`critical`	Critical（危険）
`degraded`	Degraded（劣化）
`high.critical`	High Critical（高側の危険）
`high.degraded`	High Degraded（高側の劣化）
`low.critical`	Low Critical（低側の危険）
`low.degraded`	Low Degraded（低側の劣化）
`max`	Maximum（最大）
`throttled`	Throttled（抑制）
`turbo`	Turbo（ターボ）

メトリクス: `hw.battery.time_left`

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

Name	Instrument Type	Unit (UCUM)	Description	Stability	Entity Associations
`hw.battery.time_left`	Gauge	`s`	バッテリーが完全に充電または放電されるまでの残り時間。

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.battery.state`	`Conditionally Required` If the battery is charging or discharging	string	バッテリーの現在の状態 [1]	`charging`; `discharging`
`hw.battery.capacity`	`Recommended`	string	ワット時またはアンペア時で表した設計容量	`9.3Ah`; `50Wh`
`hw.battery.chemistry`	`Recommended`	string	バッテリーの化学的組成（例：リチウムイオン、ニッケルカドミウムなど）	`Li-ion`; `NiMH`
`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.vendor`	`Recommended`	string	ハードウェアコンポーネントのベンダー名	`Dell`; `HP`; `Intel`; `AMD`; `LSI`; `Lenovo`

[1] hw.battery.state: hw.state属性は、バッテリーの現在の状態を示すべきです（should）。“charging"や"discharging"のような、事前に定義された状態のいずれかであるべきです。

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

Value	Description	Stability
`charging`	Charging（充電中）
`discharging`	Discharging（放電中）

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

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

メトリクス: `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`; `charging`; `discharging`
`hw.type`	`Required`	string	コンポーネントの種別 [2]	`battery`
`hw.battery.capacity`	`Recommended`	string	ワット時またはアンペア時で表した設計容量	`9.3Ah`; `50Wh`
`hw.battery.chemistry`	`Recommended`	string	バッテリーの化学的組成（例：リチウムイオン、ニッケルカドミウムなど）	`Li-ion`; `NiMH`
`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.vendor`	`Recommended`	string	ハードウェアコンポーネントのベンダー名	`Dell`; `HP`; `Intel`; `AMD`; `LSI`; `Lenovo`

[1] hw.state: 以下のいずれかの値に設定しなければなりません（MUST）。

ok：バッテリーは正常に動作しています。
degraded：バッテリーは機能または性能が低下した状態で動作しています。
failed：バッテリーは故障し、動作していません。
charging：バッテリーは現在充電中です。
discharging：バッテリーは現在放電中です。

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

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

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

バッテリーメトリクス hw.battery.*

メトリクス: hw.battery.charge

メトリクス: hw.battery.charge.limit

メトリクス: hw.battery.time_left

メトリクス: hw.status（バッテリー）

バッテリーメトリクス `hw.battery.*`

メトリクス: `hw.battery.charge`

メトリクス: `hw.battery.charge.limit`

メトリクス: `hw.battery.time_left`

メトリクス: `hw.status`（バッテリー）