Module: OpenTelemetry::SemConv::Incubating::HW

Defined in:
lib/opentelemetry/semconv/incubating/hw/metrics.rb,
lib/opentelemetry/semconv/incubating/hw/attributes.rb

Metrics Names collapse

HW_ENERGY =
Note:

Stability Level: development

Energy consumed by the component

'hw.energy'
HW_ERRORS =
Note:

Stability Level: development

Number of errors encountered by the component

'hw.errors'
HW_HOST_AMBIENT_TEMPERATURE =
Note:

Stability Level: development

Ambient (external) temperature of the physical host

'hw.host.ambient_temperature'
HW_HOST_ENERGY =
Note:

Stability Level: development

Total energy consumed by the entire physical host, in joules

The overall energy usage of a host MUST be reported using the specific hw.host.energy and hw.host.power metrics only, instead of the generic hw.energy and hw.power described in the previous section, to prevent summing up overlapping values.

'hw.host.energy'
HW_HOST_HEATING_MARGIN =
Note:

Stability Level: development

By how many degrees Celsius the temperature of the physical host can be increased, before reaching a warning threshold on one of the internal sensors

'hw.host.heating_margin'
HW_HOST_POWER =
Note:

Stability Level: development

Instantaneous power consumed by the entire physical host in Watts (hw.host.energy is preferred)

The overall energy usage of a host MUST be reported using the specific hw.host.energy and hw.host.power metrics only, instead of the generic hw.energy and hw.power described in the previous section, to prevent summing up overlapping values.

'hw.host.power'
HW_POWER =
Note:

Stability Level: development

Instantaneous power consumed by the component

It is recommended to report hw.energy instead of hw.power when possible.

'hw.power'
HW_STATUS =
Note:

Stability Level: development

Operational status: 1 (true) or 0 (false) for each of the possible states

hw.status is currently specified as an UpDownCounter but would ideally be represented using a StateSet as defined in OpenMetrics. This semantic convention will be updated once StateSet is specified in OpenTelemetry. This planned change is not expected to have any consequence on the way users query their timeseries backend to retrieve the values of hw.status over time.

'hw.status'

Attribute Names collapse

HW_ID =
Note:

Stability Level: development

An identifier for the hardware component, unique within the monitored host

Examples:

Sample Values

win32battery_battery_testsysa33_1
'hw.id'
HW_NAME =
Note:

Stability Level: development

An easily-recognizable name for the hardware component

Examples:

Sample Values

eth0
'hw.name'
HW_PARENT =
Note:

Stability Level: development

Unique identifier of the parent component (typically the hw.id attribute of the enclosure, or disk controller)

Examples:

Sample Values

dellStorage_perc_0
'hw.parent'
HW_STATE =
Note:

Stability Level: development

The current state of the component

'hw.state'
HW_TYPE =
Note:

Stability Level: development

Type of the component

Describes the category of the hardware component for which hw.state is being reported. For example, hw.type=temperature along with hw.state=degraded would indicate that the temperature of the hardware component has been reported as degraded.

'hw.type'