KeySafe 5 v1.7.0 OpenMetrics

KeySafe 5 exposes resource metrics in OpenMetrics format. You can pull these metrics into external systems, such as Splunk, to monitor your system.

HSMs

GET /mgmt/v1/hsms/<hsmid>/metrics

Each HSM has a metrics endpoint that reports metrics for that module. Some metrics are available only to specific HSM types.

Example

Click to expand

# TYPE nshield_temperature_limit_celsius gauge
# UNIT nshield_temperature_limit_celsius celsius
# HELP nshield_temperature_limit_celsius The maximum limit of acceptable value for each temperature sensor.
nshield_temperature_limit_celsius{esn="5C95-638E-D5D7",sensor="module_cpu_temp",limit="maximum"} 80
nshield_temperature_limit_celsius{esn="5C95-638E-D5D7",sensor="module_msp_temp",limit="maximum"} 65
nshield_temperature_limit_celsius{esn="5C95-638E-D5D7",sensor="module_crypto_co_proc_temp",limit="maximum"} 80
nshield_temperature_limit_celsius{esn="5C95-638E-D5D7",sensor="chassis_processor",limit="maximum"} 70
nshield_temperature_limit_celsius{esn="5C95-638E-D5D7",sensor="chassis_inlet_left",limit="maximum"} 45
nshield_temperature_limit_celsius{esn="5C95-638E-D5D7",sensor="chassis_inlet_right",limit="maximum"} 45
# TYPE nshield_fan_speed_limit_rpm gauge
# UNIT nshield_fan_speed_limit_rpm rpm
# HELP nshield_fan_speed_limit_rpm The fan speed limits for each fan in the HSM.
nshield_fan_speed_limit_rpm{esn="5C95-638E-D5D7",fan_id="chassis3",limit="minimum"} 8000
nshield_fan_speed_limit_rpm{esn="5C95-638E-D5D7",fan_id="chassis3",limit="maximum"} 18700
nshield_fan_speed_limit_rpm{esn="5C95-638E-D5D7",fan_id="chassis4",limit="minimum"} 8000
nshield_fan_speed_limit_rpm{esn="5C95-638E-D5D7",fan_id="chassis4",limit="maximum"} 18700
nshield_fan_speed_limit_rpm{esn="5C95-638E-D5D7",fan_id="chassis1",limit="minimum"} 8000
nshield_fan_speed_limit_rpm{esn="5C95-638E-D5D7",fan_id="chassis1",limit="maximum"} 18700
nshield_fan_speed_limit_rpm{esn="5C95-638E-D5D7",fan_id="chassis2",limit="minimum"} 8000
nshield_fan_speed_limit_rpm{esn="5C95-638E-D5D7",fan_id="chassis2",limit="maximum"} 18700
# TYPE nshield_platform_voltage_volts gauge
# UNIT nshield_platform_voltage_volts volts
# HELP nshield_platform_voltage_volts The voltage measured on each rail.
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="chassis_battery"} 3.65
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="5VStandby"} 4.9
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="12V"} 11.67
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="t1022_serdes"} 0.9954308
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="fpga_serdes_io"} 4.9255776
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="ddr4_access"} 2.48781168
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="cpu_core"} 0.98584746
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="fpga_serdes_core"} 0.72215104
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="module_battery"} 3.235966
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="t1022_serdes_io"} 1.34002237
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="pci_bus"} 11.6993955
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="ddr4_io"} 1.19293146
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="msp_avcc"} 3.3006072
nshield_platform_voltage_volts{esn="5C95-638E-D5D7",voltage_sensor="t1022_ifc_io"} 1.8039588
# TYPE nshield_AIS31_preliminary_alarms counter
# HELP nshield_AIS31_preliminary_alarms Reports the number of times the AIS31 random number test has failed.
nshield_AIS31_preliminary_alarms_total{esn="5C95-638E-D5D7"} 0
nshield_AIS31_preliminary_alarms_created{esn="5C95-638E-D5D7"} 1769082754
# TYPE nshield_uptime_seconds counter
# UNIT nshield_uptime_seconds seconds
# HELP nshield_uptime_seconds The length of time the HSM has been running.
nshield_uptime_seconds_total{esn="5C95-638E-D5D7"} 361602
nshield_uptime_seconds_created{esn="5C95-638E-D5D7"} 1769082754
# TYPE nshield_module_worn_blocks_per_nvram gauge
# HELP nshield_module_worn_blocks_per_nvram The percentage of worn blocks in the NVRAM of the HSM.
nshield_module_worn_blocks_per_nvram{esn="5C95-638E-D5D7"} 0
# TYPE nshield_temperature_celsius gauge
# UNIT nshield_temperature_celsius celsius
# HELP nshield_temperature_celsius The temperature of the HSM main circuit board.
nshield_temperature_celsius{esn="5C95-638E-D5D7",sensor="module_msp_temp"} 35
nshield_temperature_celsius{esn="5C95-638E-D5D7",sensor="chassis_inlet_left"} 26
nshield_temperature_celsius{esn="5C95-638E-D5D7",sensor="chassis_processor"} 32
nshield_temperature_celsius{esn="5C95-638E-D5D7",sensor="chassis_inlet_right"} 27
nshield_temperature_celsius{esn="5C95-638E-D5D7",sensor="chassis_outlet_left"} 29
nshield_temperature_celsius{esn="5C95-638E-D5D7",sensor="chassis_outlet_right"} 27.5
nshield_temperature_celsius{esn="5C95-638E-D5D7",sensor="module_crypto_co_proc_temp"} 36
nshield_temperature_celsius{esn="5C95-638E-D5D7",sensor="module_cpu_temp"} 46
# TYPE nshield_module_nvram_erase_per_endurance gauge
# HELP nshield_module_nvram_erase_per_endurance The wear level of the HSM's NVRAM, expressed as a percentage of the ratio between the erase count and the endurance.
nshield_module_nvram_erase_per_endurance{esn="5C95-638E-D5D7"} 0.003
# TYPE nshield_spi_communication_attempts counter
# HELP nshield_spi_communication_attempts Reports the times the XC Main Processor has had to initiate another attempt to communicate with the Security Processor due to comms failure.
nshield_spi_communication_attempts_total{esn="5C95-638E-D5D7"} 0
nshield_spi_communication_attempts_created{esn="5C95-638E-D5D7"} 1769082754
# TYPE nshield_max_temperature_celsius gauge
# UNIT nshield_max_temperature_celsius celsius
# HELP nshield_max_temperature_celsius The maximum temperature recorded by the HSM's temperature sensor.
nshield_max_temperature_celsius{esn="5C95-638E-D5D7",sensor="module_cpu_temp"} 48
# TYPE nshield_module_nvram_free_bytes gauge
# UNIT nshield_module_nvram_free_bytes bytes
# HELP nshield_module_nvram_free_bytes The total amount of free space in the NVRAM of the HSM.
nshield_module_nvram_free_bytes{esn="5C95-638E-D5D7"} 2.13598208e+08
# TYPE nshield_module_mem_bytes gauge
# UNIT nshield_module_mem_bytes bytes
# HELP nshield_module_mem_bytes The total amount of RAM (both allocated and free) available to the HSM.
nshield_module_mem_bytes{esn="5C95-638E-D5D7"} 8.304115712e+09
# TYPE nshield_correctable_memory_errors counter
# HELP nshield_correctable_memory_errors Counter reporting the number of correctable memory errors have been corrected by the onboard error-checking and correction (ECC) mechanisms.
nshield_correctable_memory_errors_total{esn="5C95-638E-D5D7"} 0
nshield_correctable_memory_errors_created{esn="5C95-638E-D5D7"} 1769082754
# TYPE nshield_min_temperature_celsius gauge
# UNIT nshield_min_temperature_celsius celsius
# HELP nshield_min_temperature_celsius The minimum temperature recorded by the HSM's temperature sensor.
nshield_min_temperature_celsius{esn="5C95-638E-D5D7",sensor="module_cpu_temp"} 32
# TYPE nshield_cpu_throttled stateset
# HELP nshield_cpu_throttled Indicates whether the main processor is being throttled to avoid over-heating.
nshield_cpu_throttled{esn="5C95-638E-D5D7",nshield_cpu_throttled="okay"} 1
nshield_cpu_throttled{esn="5C95-638E-D5D7",nshield_cpu_throttled="throttled"} 0
# TYPE nshield_cpu_load_average_per_hsm gauge
# HELP nshield_cpu_load_average_per_hsm The processing load average on the HSM over the time specified by source.
nshield_cpu_load_average_per_hsm{esn="5C95-638E-D5D7",source="5min"} 8.55
nshield_cpu_load_average_per_hsm{esn="5C95-638E-D5D7",source="15min"} 7.59
nshield_cpu_load_average_per_hsm{esn="5C95-638E-D5D7",source="1min"} 9.98
# TYPE nshield_chassis_system_disk_percentage gauge
# HELP nshield_chassis_system_disk_percentage The percentage used of the storage reserved for internal software components.
nshield_chassis_system_disk_percentage{esn="5C95-638E-D5D7"} 0.1
# TYPE nshield_chassis_virtual_mem_bytes gauge
# UNIT nshield_chassis_virtual_mem_bytes bytes
# HELP nshield_chassis_virtual_mem_bytes Total memory in the system.
nshield_chassis_virtual_mem_bytes{esn="5C95-638E-D5D7"} 7.9021056e+09
# TYPE nshield_error_conditions stateset
# HELP nshield_error_conditions Error conditions reported by the chassis.
nshield_error_conditions{esn="5C95-638E-D5D7",source="fan2",nshield_error_conditions="okay"} 1
nshield_error_conditions{esn="5C95-638E-D5D7",source="fan2",nshield_error_conditions="failed"} 0
nshield_error_conditions{esn="5C95-638E-D5D7",source="fan3",nshield_error_conditions="okay"} 1
nshield_error_conditions{esn="5C95-638E-D5D7",source="fan3",nshield_error_conditions="failed"} 0
nshield_error_conditions{esn="5C95-638E-D5D7",source="fan4",nshield_error_conditions="okay"} 1
nshield_error_conditions{esn="5C95-638E-D5D7",source="fan4",nshield_error_conditions="failed"} 0
nshield_error_conditions{esn="5C95-638E-D5D7",source="chassis_battery_low",nshield_error_conditions="okay"} 1
nshield_error_conditions{esn="5C95-638E-D5D7",source="chassis_battery_low",nshield_error_conditions="failed"} 0
nshield_error_conditions{esn="5C95-638E-D5D7",source="fan1",nshield_error_conditions="okay"} 1
nshield_error_conditions{esn="5C95-638E-D5D7",source="fan1",nshield_error_conditions="failed"} 0
nshield_error_conditions{esn="5C95-638E-D5D7",source="psu_failed",nshield_error_conditions="okay"} 1
nshield_error_conditions{esn="5C95-638E-D5D7",source="psu_failed",nshield_error_conditions="failed"} 0
# TYPE nshield_fan_speed_rpm gauge
# UNIT nshield_fan_speed_rpm rpm
# HELP nshield_fan_speed_rpm The fan speed for each fan in the HSM.
nshield_fan_speed_rpm{esn="5C95-638E-D5D7",fan_id="chassis2"} 8939
nshield_fan_speed_rpm{esn="5C95-638E-D5D7",fan_id="chassis3"} 8939
nshield_fan_speed_rpm{esn="5C95-638E-D5D7",fan_id="chassis1"} 8939
nshield_fan_speed_rpm{esn="5C95-638E-D5D7",fan_id="chassis4"} 8939
# TYPE nshield_platform_current_amperes gauge
# UNIT nshield_platform_current_amperes amperes
# HELP nshield_platform_current_amperes The current measured on each rail.
nshield_platform_current_amperes{esn="5C95-638E-D5D7",current_sensor="12V"} 3.17
nshield_platform_current_amperes{esn="5C95-638E-D5D7",current_sensor="5VStandby"} 0.37
# TYPE nshield_chassis_manufacturer_disk_percentage gauge
# HELP nshield_chassis_manufacturer_disk_percentage The percentage used of the storage reserved for manufacturing data.
nshield_chassis_manufacturer_disk_percentage{esn="5C95-638E-D5D7"} 0
# TYPE nshield_chassis_user_disk_percentage gauge
# HELP nshield_chassis_user_disk_percentage The percentage used of the storage available for user configuration and logs.
nshield_chassis_user_disk_percentage{esn="5C95-638E-D5D7"} 0.7
# TYPE nshield_chassis_virtual_mem_available_bytes gauge
# UNIT nshield_chassis_virtual_mem_available_bytes bytes
# HELP nshield_chassis_virtual_mem_available_bytes An estimate of how much memory is available for starting new applications, without swapping.
nshield_chassis_virtual_mem_available_bytes{esn="5C95-638E-D5D7"} 6.499885056e+09
# TYPE nshield_chassis_virtual_mem_free_bytes gauge
# UNIT nshield_chassis_virtual_mem_free_bytes bytes
# HELP nshield_chassis_virtual_mem_free_bytes The amount of memory left unused by the system.
nshield_chassis_virtual_mem_free_bytes{esn="5C95-638E-D5D7"} 5.04612864e+09
# TYPE nshield_hsm_liveness gauge
# HELP nshield_hsm_liveness Whether metrics could be gathered for this HSM.
nshield_hsm_liveness{esn="5C95-638E-D5D7"} 1
# EOF

Metrics

Some metrics are available only to specific HSM types. In the following table, metrics are described as 'Platform' when they are provided by the hardware and are available to a platform or a full HSM. Metrics described as 'Tenancy' are available to a tenant or to a full HSM. An HSM metric on a Tenant HSM will have a vcm label.

Metric	HSM	Type	Unit	Labels	Description
nshield_AIS31_preliminary_alarms	Platform	counter		esn	Reports the number of times the AIS31 random number test has failed.
nshield_audit_db_free_bytes	Tenancy	gauge	bytes	esn, vcm	Free space in the audit database.
nshield_audit_db_used_bytes	Tenancy	gauge	bytes	esn, vcm	Space used in the audit database.
nshield_chassis_manufacturer_disk_percentage	Platform	gauge		esn	The percentage used of the storage reserved for manufacturing data.
nshield_chassis_mem_alloc_kernel_bytes	Platform	gauge	bytes	esn	Deprecated
nshield_chassis_mem_alloc_user_bytes	Platform	gauge	bytes	esn	Deprecated
nshield_chassis_system_disk_percentage	Platform	gauge		esn	The percentage used of the storage reserved for internal software components.
nshield_chassis_user_disk_percentage	Platform	gauge		esn	The percentage used of the storage available for user configuration and logs.
nshield_chassis_virtual_mem_available_bytes	Platform	gauge	bytes	esn	An estimate of how much memory is available for starting new applications, without swapping.
nshield_chassis_virtual_mem_bytes	Platform	gauge	bytes	esn	Total memory in the system.
nshield_chassis_virtual_mem_free_bytes	Platform	gauge	bytes	esn	The amount of memory left unused by the system.
nshield_commands	Tenancy	counter		esn, vcm	The total number of commands sent for processing from any server to the HSM.
nshield_correctable_memory_errors	Platform	counter		esn	Counter reporting the number of correctable memory errors have been corrected by the onboard error-checking and correction mechanisms.
nshield_cpu_load_average_per_hsm	Platform	gauge		esn, source	The processing load average on the HSM over the time specified by source.
nshield_cpu_load_per_hsm	Platform	gauge		esn, source	The processing load on the HSM. Because an HSM typically contains a number of different types of processing resources, for example, main CPU and RSA acceleration, this figure is hard to interpret precisely. In general, HSMs report 100% CPU load when all RSA processing capacity is occupied; when performing non-RSA tasks the main CPU or other resources, such as the random number generator, can be saturated without this statistic reaching 100%.
nshield_cpu_throttled	Platform	stateset		esn	Indicates whether the main processor is being throttled to avoid over-heating; it will have an impact on crypto performance. Only available on nShield 5 variants.
nshield_current_clients	Tenancy	gauge		esn, vcm	The number of client connections currently made to the hardserver.
nshield_current_clients_limit	Tenancy	gauge		esn, vcm	The number of licensed client connections available.
nshield_current_crypto_clients	Tenancy	gauge		esn, vcm	The number of connected remote crypto clients, both active and parked sessions.
nshield_current_crypto_clients_limit	Tenancy	gauge		esn, vcm	The number of licensed crypto client connections available.
nshield_error_conditions	Platform	stateset		esn, source	Error conditions reported by the chassis.
nshield_fan_speed_limit_rpm	Platform	gauge	rpm	esn, fan_id, limit	The fan speed limits for each fan in the HSM.
nshield_fan_speed_rpm	Platform	gauge	rpm	esn, fan_id	The fan speed for each fan in the HSM.
nshield_hsm	Platform/Tenancy	info		esn, vcm, label	The labels associated with the HSM.
nshield_hsm_liveness	Platform	gauge		esn	Whether metrics could be gathered for this HSM.
nshield_max_temperature_celsius	Platform	gauge	celsius	esn, sensor	The maximum temperature recorded by the HSM’s temperature sensor. This is only cleared when the unit is initialized.
nshield_min_temperature_celsius	Platform	gauge	celsius	esn, sensor	The minimum temperature recorded by the HSM’s temperature sensor. This is only cleared when the unit is initialized.
nshield_module_mem_alloc_kernel_bytes	Platform	gauge	bytes	esn	The total amount of RAM allocated for kernel, meaning non-SEE, use in a module. This is principally used for the object store, for example keys and logical tokens, and for big-number buffers.
nshield_module_mem_alloc_user_bytes	Platform	gauge	bytes	esn	The total amount of RAM allocated for user-mode processes in the module. This will be zero for non-SEE use. This includes the size of the SEE Machine image, and the total heap space available to it.
nshield_module_mem_bytes	Platform	gauge	bytes	esn	The total amount of RAM, both allocated and free, available to the HSM.
nshield_module_nvram_erase_per_endurance	Platform	gauge		esn	The wear level of the HSM’s NVRAM, expressed as a percentage of the ratio between the erase count and the endurance. Only available on XC and nShield 5 variants.
nshield_module_nvram_free_bytes	Platform	gauge	bytes	esn	The total amount of free space in the NVRAM of the HSM. Only available on XC and nShield 5 variants.
nshield_module_worn_blocks_per_nvram	Platform	gauge		esn	The percentage of worn blocks in the NVRAM of the HSM. Only available on XC and nShield 5 variants.
nshield_objects_destroyed	Tenancy	counter		esn, vcm	The number of items in the HSM’s object store that have been deleted and their corresponding memory released.
nshield_objects_stored	Tenancy	counter		esn, vcm	The number of times a new object has been put into the object store.
nshield_pci_irqs	Platform	counter		esn	On PCI HSMs, the total number of interrupts received from the host.
nshield_pci_read_reconnect	Platform	counter		esn	On PCI HSMs, the number of deferred reads that have now completed.
nshield_pci_unhandled_irqs	Platform	counter		esn	On PCI HSMs, the number of unidentified interrupts from the host. If this is nonzero, a driver or PCI bus problem is likely.
nshield_platform_current_amperes	Platform	gauge	amperes	esn, current_sensor	The current measured on each rail.
nshield_platform_voltage_volts	Platform	gauge	volts	esn, voltage_sensor	The voltage measured on each rail.
nshield_queue_in_progress	Tenancy	gauge		esn, vcm	The number of jobs that are in progress on the HSM. This value includes all jobs on the module, including jobs from the SEE machine.
nshield_queue_length_limit	Tenancy	gauge		esn, vcm, limit	queue length (maximum and minimum).
nshield_replies	Tenancy	counter		esn, vcm	The total number of replies returned from HSM to any client.
nshield_spi_communication_attempts	Platform	counter		esn	Reports the times the XC Main Processor has had to initiate another attempt to communicate with the Security Processor due to comms failure.
nshield_temperature_celsius	Platform	gauge	celsius	esn, sensor	The temperature of the HSM main circuit board.
nshield_temperature_limit_celsius	Platform	gauge	celsius	esn, sensor, limit	The maximum limit of acceptable value for each temperature sensor.
nshield_uptime_seconds	Platform	counter	seconds	esn	The length of time the HSM has been running.

Metric

HSM

Type

Unit

Labels

Description

nshield_AIS31_preliminary_alarms

Platform

counter

esn

Reports the number of times the AIS31 random number test has failed.

nshield_audit_db_free_bytes

Tenancy

gauge

bytes

esn, vcm

Free space in the audit database.

nshield_audit_db_used_bytes

Tenancy

gauge

bytes

esn, vcm

Space used in the audit database.

nshield_chassis_manufacturer_disk_percentage

Platform

gauge

esn

The percentage used of the storage reserved for manufacturing data.

nshield_chassis_mem_alloc_kernel_bytes

Platform

gauge

bytes

esn

Deprecated

nshield_chassis_mem_alloc_user_bytes

Platform

gauge

bytes

esn

Deprecated

nshield_chassis_system_disk_percentage

Platform

gauge

esn

The percentage used of the storage reserved for internal software components.

nshield_chassis_user_disk_percentage

Platform

gauge

esn

The percentage used of the storage available for user configuration and logs.

nshield_chassis_virtual_mem_available_bytes

Platform

gauge

bytes

esn

An estimate of how much memory is available for starting new applications, without swapping.

nshield_chassis_virtual_mem_bytes

Platform

gauge

bytes

esn

Total memory in the system.

nshield_chassis_virtual_mem_free_bytes

Platform

gauge

bytes

esn

The amount of memory left unused by the system.

nshield_commands

Tenancy

counter

esn, vcm

The total number of commands sent for processing from any server to the HSM.

nshield_correctable_memory_errors

Platform

counter

esn

Counter reporting the number of correctable memory errors have been corrected by the onboard error-checking and correction mechanisms.

nshield_cpu_load_average_per_hsm

Platform

gauge

esn, source

The processing load average on the HSM over the time specified by source.

nshield_cpu_load_per_hsm

Platform

gauge

esn, source

The processing load on the HSM. Because an HSM typically contains a number of different types of processing resources, for example, main CPU and RSA acceleration, this figure is hard to interpret precisely. In general, HSMs report 100% CPU load when all RSA processing capacity is occupied; when performing non-RSA tasks the main CPU or other resources, such as the random number generator, can be saturated without this statistic reaching 100%.

nshield_cpu_throttled

Platform

stateset

esn

Indicates whether the main processor is being throttled to avoid over-heating; it will have an impact on crypto performance. Only available on nShield 5 variants.

nshield_current_clients

Tenancy

gauge

esn, vcm

The number of client connections currently made to the hardserver.

nshield_current_clients_limit

Tenancy

gauge

esn, vcm

The number of licensed client connections available.

nshield_current_crypto_clients

Tenancy

gauge

esn, vcm

The number of connected remote crypto clients, both active and parked sessions.

nshield_current_crypto_clients_limit

Tenancy

gauge

esn, vcm

The number of licensed crypto client connections available.

nshield_error_conditions

Platform

stateset

esn, source

Error conditions reported by the chassis.

nshield_fan_speed_limit_rpm

Platform

gauge

rpm

esn, fan_id, limit

The fan speed limits for each fan in the HSM.

nshield_fan_speed_rpm

Platform

gauge

rpm

esn, fan_id

The fan speed for each fan in the HSM.

nshield_hsm

Platform/Tenancy

info

esn, vcm, label

The labels associated with the HSM.

nshield_hsm_liveness

Platform

gauge

esn

Whether metrics could be gathered for this HSM.

nshield_max_temperature_celsius

Platform

gauge

celsius

esn, sensor

The maximum temperature recorded by the HSM’s temperature sensor. This is only cleared when the unit is initialized.

nshield_min_temperature_celsius

Platform

gauge

celsius

esn, sensor

The minimum temperature recorded by the HSM’s temperature sensor. This is only cleared when the unit is initialized.

nshield_module_mem_alloc_kernel_bytes

Platform

gauge

bytes

esn

The total amount of RAM allocated for kernel, meaning non-SEE, use in a module. This is principally used for the object store, for example keys and logical tokens, and for big-number buffers.

nshield_module_mem_alloc_user_bytes

Platform

gauge

bytes

esn

The total amount of RAM allocated for user-mode processes in the module. This will be zero for non-SEE use.

This includes the size of the SEE Machine image, and the total heap space available to it.

nshield_module_mem_bytes

Platform

gauge

bytes

esn

The total amount of RAM, both allocated and free, available to the HSM.

nshield_module_nvram_erase_per_endurance

Platform

gauge

esn

The wear level of the HSM’s NVRAM, expressed as a percentage of the ratio between the erase count and the endurance. Only available on XC and nShield 5 variants.

nshield_module_nvram_free_bytes

Platform

gauge

bytes

esn

The total amount of free space in the NVRAM of the HSM. Only available on XC and nShield 5 variants.

nshield_module_worn_blocks_per_nvram

Platform

gauge

esn

The percentage of worn blocks in the NVRAM of the HSM. Only available on XC and nShield 5 variants.

nshield_objects_destroyed

Tenancy

counter

esn, vcm

The number of items in the HSM’s object store that have been deleted and their corresponding memory released.

nshield_objects_stored

Tenancy

counter

esn, vcm

The number of times a new object has been put into the object store.

nshield_pci_irqs

Platform

counter

esn

On PCI HSMs, the total number of interrupts received from the host.

nshield_pci_read_reconnect

Platform

counter

esn

On PCI HSMs, the number of deferred reads that have now completed.

nshield_pci_unhandled_irqs

Platform

counter

esn

On PCI HSMs, the number of unidentified interrupts from the host. If this is nonzero, a driver or PCI bus problem is likely.

nshield_platform_current_amperes

Platform

gauge

amperes

esn, current_sensor

The current measured on each rail.

nshield_platform_voltage_volts

Platform

gauge

volts

esn, voltage_sensor

The voltage measured on each rail.

nshield_queue_in_progress

Tenancy

gauge

esn, vcm

The number of jobs that are in progress on the HSM. This value includes all jobs on the module, including jobs from the SEE machine.

nshield_queue_length_limit

Tenancy

gauge

esn, vcm, limit

queue length (maximum and minimum).

nshield_replies

Tenancy

counter

esn, vcm

The total number of replies returned from HSM to any client.

nshield_spi_communication_attempts

Platform

counter

esn

Reports the times the XC Main Processor has had to initiate another attempt to communicate with the Security Processor due to comms failure.

nshield_temperature_celsius

Platform

gauge

celsius

esn, sensor

The temperature of the HSM main circuit board.

nshield_temperature_limit_celsius

Platform

gauge

celsius

esn, sensor, limit

The maximum limit of acceptable value for each temperature sensor.

nshield_uptime_seconds

Platform

counter

seconds

esn

The length of time the HSM has been running.

Hosts

GET /mgmt/v1/hosts/<hostid>/metrics

Each host resource has a metrics endpoint that reports metrics for that host.

Example

Click to expand

# TYPE nshield_host_liveness gauge
# HELP nshield_host_liveness Boolean Host liveness. (1=live)
nshield_host_liveness{host="4fd93b3a-b09c-43ca-8d89-e76a17808bc4"} 0
# TYPE nshield_hardserver_liveness gauge
# HELP nshield_hardserver_liveness Boolean Hardserver health. (1=live)
nshield_hardserver_liveness{host="4fd93b3a-b09c-43ca-8d89-e76a17808bc4"} 1
# EOF

Metrics

Metric	Type	Unit	Labels	Description
nshield_audit_db_free_bytes	gauge	bytes	host	Free space in the audit database.
nshield_audit_db_used_bytes	gauge	bytes	host	Space used in the audit database.
nshield_connection_commands	counter		host, connection	The total number of commands sent for processing from a client to the server for each connection.
nshield_connection_replies	counter		host, connection	The total number of replies returned from server to client for each connection.
nshield_current_clients	gauge		host	The number of client connections currently made to the server.
nshield_current_crypto_clients	gauge		host	The number of licensable clients connected, both active and parked sessions.
nshield_hardserver_liveness	gauge		host	Whether the hardserver is considered live (still running).
nshield_host	info		host, label	The labels associated with the host.
nshield_host_connection	info		host, connection, processid, processname	Information about each connection to this host.
nshield_host_liveness	gauge		host	Whether the host is considered live (has sent an update recently).

Metric

Type

Unit

Labels

Description

nshield_audit_db_free_bytes

gauge

bytes

host

Free space in the audit database.

nshield_audit_db_used_bytes

gauge

bytes

host

Space used in the audit database.

nshield_connection_commands

counter

host, connection

The total number of commands sent for processing from a client to the server for each connection.

nshield_connection_replies

counter

host, connection

The total number of replies returned from server to client for each connection.

nshield_current_clients

gauge

host

The number of client connections currently made to the server.

nshield_current_crypto_clients

gauge

host

The number of licensable clients connected, both active and parked sessions.

nshield_hardserver_liveness

gauge

host

Whether the hardserver is considered live (still running).

nshield_host

info

host, label

The labels associated with the host.

nshield_host_connection

info

host, connection, processid, processname

Information about each connection to this host.

nshield_host_liveness

gauge

host

Whether the host is considered live (has sent an update recently).

Codesafe

GET /codesafe/v1/metrics

The CodeSafe service provides a single metrics endpoint that returns statistics, where available, for every SEE machine in the Running state. Where metrics cannot be retrieved, they will be omitted.

Example

Click to expand

# HELP codesafe5_cpu_usage_seconds CPU usage in seconds
# TYPE codesafe5_cpu_usage_seconds counter
# UNIT codesafe5_cpu_usage_seconds seconds
codesafe5_cpu_use_seconds_total{uuid="acde070d-8c4c-4f0d-9d8a-162843c10333",esn="1234-5678-ABCD",package_name="helloworld"} 0
codesafe5_cpu_use_seconds_created{uuid="acde070d-8c4c-4f0d-9d8a-162843c10333",esn="1234-5678-ABCD",package_name="helloworld"} 1520430000.123
# HELP codesafe5_memory_usage_bytes Mem usage
# TYPE codesafe5_memory_usage_bytes gauge
# UNITS codesafe5_memory_usage_bytes bytes
codesafe5_memory_usage_bytes{uuid="acde070d-8c4c-4f0d-9d8a-162843c10333",esn="1234-5678-ABCD",package_name="helloworld"} 10000
# HELP codesafe5_kmem_usage_bytes Kmem usage
# TYPE codesafe5_kmem_usage_bytes gauge
# UNITS codesafe5_kmem_usage_bytes bytes
codesafe5_kmem_usage_bytes{uuid="acde070d-8c4c-4f0d-9d8a-162843c10333",esn="1234-5678-ABCD",package_name="helloworld"} 20000
# HELP codesafe5_link_bytes Information on the link
# TYPE codesafe5_link_bytes counter
# UNITS codesafe5_link_bytes bytes
codesafe5_link_bytes_total{uuid="acde070d-8c4c-4f0d-9d8a-162843c10333",esn="1234-5678-ABCD",package_name="helloworld",direction="transmit"} 100
codesafe5_link_bytes_created{uuid="acde070d-8c4c-4f0d-9d8a-162843c10333",esn="1234-5678-ABCD",package_name="helloworld",direction="transmit"} 1520430000.123
codesafe5_link_bytes_total{uuid="acde070d-8c4c-4f0d-9d8a-162843c10333",esn="1234-5678-ABCD",package_name="helloworld",direction="receive"} 200
codesafe5_link_bytes_created{uuid="acde070d-8c4c-4f0d-9d8a-162843c10333",esn="1234-5678-ABCD",package_name="helloworld",direction="receive"} 1520430000.123
# EOF

Metrics

Metric	Type	Unit	Labels	Description
codesafe5_cpu_usage_seconds	counter	seconds	uuid, esn, package_name	CPU usage.
codesafe5_kmem_usage_bytes	gauge	bytes	uuid, esn, package_name	Kmem usage.
codesafe5_link_bytes	counter	bytes	uuid, esn, package_name, direction	Link data transferred reported for both 'receive' and 'transmit'.
codesafe5_memory_usage_bytes	gauge	bytes	uuid, esn, package_name	Memory usage.

Metric

Type

Unit

Labels

Description

codesafe5_cpu_usage_seconds

counter

seconds

uuid, esn, package_name

CPU usage.

codesafe5_kmem_usage_bytes

gauge

bytes

uuid, esn, package_name

Kmem usage.

codesafe5_link_bytes

counter

bytes

uuid, esn, package_name, direction

Link data transferred reported for both 'receive' and 'transmit'.

codesafe5_memory_usage_bytes

gauge

bytes

uuid, esn, package_name

Memory usage.

Licensing

GET /licensing/v1/metrics

The licensing service provides a single metrics endpoint for system licenses.

Example

Click to expand

# HELP keysafe5_licence_expiry The length of time (in seconds) until the licence expires
# TYPE keysafe5_licence_expiry gauge
# UNIT keysafe5_licence_expiry seconds
keysafe5_licence_expiry{licence="Estate Monitoring"} 0
# EOF

Metrics

Metric	Type	Unit	Labels	Description
keysafe5_licence_expiry	gauge	seconds	licence	The length of time (in seconds) until the licence expires. Currently the only available licence is "Estate Monitoring".

Metric

Type

Unit

Labels

Description

keysafe5_licence_expiry

gauge

seconds

licence

The length of time (in seconds) until the licence expires. Currently the only available licence is "Estate Monitoring".

System

Metrics for the system and its agents.

Example

Click to expand

# HELP keysafe5_certificate_expiry The length of time (in seconds) until the certificate expires
# TYPE keysafe5_certificate_expiry gauge
# UNIT keysafe5_certificate_expiry seconds
keysafe5_certificate_expiry{agent="agentid",type="agent",subject="subject",issuer="issuer"} 0
# EOF

Metrics

Metric	Type	Unit	Labels	Description
keysafe5_certificate_expiry	gauge	seconds	agent, type, subject, issuer	The length of time (in seconds) until the certificate expires. Labels identify the type of certificate ("agent", "central", or "ca") and where the certificate belongs to an agent the id of that agent.

Metric

Type

Unit

Labels

Description

keysafe5_certificate_expiry

gauge

seconds

agent, type, subject, issuer

The length of time (in seconds) until the certificate expires. Labels identify the type of certificate ("agent", "central", or "ca") and where the certificate belongs to an agent the id of that agent.