Metrics

Metrics can be viewed for single HSMs or summed across all HSMs.

Labels

  • esn: The ESN of the HSM

  • sensor: The CPU temperature sensor providing the reading

  • voltage_type: The type of voltage being measured

  • fan_id: The fan number

  • source: Whether the metric came from the chassis or the module

  • limit: Whether the value is the minimum or maximum limit.

  • host: The UUID of the host

Historical metrics

nShield Monitor History Notes KeySafe5 historical metric type Valid parameters OpenMetric Supported HSM types

Object Count

The difference between the number of objects created and the number of objects destroyed.

Objects Stored

esn, vcm

HSM: nshield_objects_stored

Full, tenant

Objects Destroyed

esn, vcm

HSM: nshield_objects_destroyed

Full, tenant

Command Count

Commands Received

esn, vcm

HSM: nshield_commands

Full, tenant

Replies sent

esn, vcm

HSM: nshield_replies

Full, tenant

Metric reported per connection

Client Commands Received

host

Host: nshield_connection_commands

Not applicable

Metric reported per connection

Client Replies Sent

host

Host: nshield_connection_replies

Not applicable

Job Queue

esn, vcm

HSM: nshield_queue_in_progress

Full, tenant

Current metrics

The instantaneous value of metrics, reported in a way that enables the KeySafe5 UI to determine whether they are "good" or "bad".

KS5 current metric type Notes Valid parameters OpenMetrics used Supported HSM types

HSM Fan Speed

A comprehensive view of current HSM fan speeds.

esn

nshield_fan_speed_rpm

nshield_fan_speed_limit_rpm

Full, platform

HSM Temperature Percentage

A comprehensive view of HSM temperature, reported as a percentage of the maximum temperature reached.

esn

nshield_temperature_celsius

nshield_temperature_limit_celsius

Full, platform

HSM Memory Usage Percentage

The percentage of module memory currently in use.

esn

nshield_module_mem_bytes

nshield_module_mem_alloc_kernel_bytes

nshield_module_mem_alloc_user_bytes

Full, platform