AWS CloudHSM

Overview

AWS CloudHSM is a service that provides hardware security modules for use in the AWS Cloud.

Enable this integration to see all of your CloudHSM metrics in Datadog.

Setup

Installation

If you haven’t already, set up the Amazon Web Services integration first.

Metric collection

  1. In the AWS integration page, ensure that CloudHSM is enabled under the Metric Collection tab.
  2. Install the Datadog - AWS CloudHSM integration.

Log collection

Enable logging

Configure AWS CloudHSM to send logs either to a S3 bucket or to CloudWatch.

Note: If you log to a S3 bucket, make sure that amazon_cloudhsm is set as Target prefix.

Send logs to Datadog

  1. If you haven’t already, set up the Datadog Forwarder Lambda function.

  2. Once the Lambda function is installed, manually add a trigger on the S3 bucket or CloudWatch log group that contains your AWS CloudHSM logs in the AWS console:

Data Collected

Metrics

aws.cloudhsm.hsm_keys_session_occupied
(gauge)		The amount of buffered memory.
Shown as key
aws.cloudhsm.hsm_keys_session_occupied.sum
(count)		The sum of the amount of buffered memory.
Shown as key
aws.cloudhsm.hsm_keys_token_occupied
(gauge)		The number of occupied keys
Shown as key
aws.cloudhsm.hsm_keys_token_occupied.sum
(count)		The sum of the number of occupied keys
Shown as key
aws.cloudhsm.hsm_session_count
(count)		The sum of the open connections.
Shown as session
aws.cloudhsm.hsm_session_count.average
(gauge)		The number of open connections.
Shown as session
aws.cloudhsm.hsm_session_count.maximum
(gauge)		The max number of open connections.
Shown as session
aws.cloudhsm.hsm_ssl_ctxs_occupied
(gauge)		The number of established encrypted channels.
Shown as process
aws.cloudhsm.hsm_ssl_ctxs_occupied.sum
(count)		The sum of the number of established encrypted channels.
Shown as process
aws.cloudhsm.hsm_temperature
(gauge)		The junction temperature of the hardware processor
Shown as degree celsius
aws.cloudhsm.hsm_temperature.maximum
(gauge)		The maximum junction temperature of the hardware processor
Shown as degree celsius
aws.cloudhsm.hsm_unhealthy
(count)		The sum of unhealthy HSM instances.
Shown as event
aws.cloudhsm.hsm_unhealthy.average
(gauge)		The average number of unhealthy HSM instances.
Shown as event
aws.cloudhsm.hsm_unhealthy.maximum
(gauge)		The maximum number of unhealthy HSM instances.
Shown as event
aws.cloudhsm.hsm_users_available
(gauge)		The number of available hsm users
Shown as user
aws.cloudhsm.hsm_users_max
(gauge)		The max number of hsm users.
Shown as user
aws.cloudhsm.interface_eth_2dropped_input
(gauge)
aws.cloudhsm.interface_eth_2dropped_input.sum
(count)
aws.cloudhsm.interface_eth_2dropped_output
(gauge)
aws.cloudhsm.interface_eth_2dropped_output.sum
(count)
aws.cloudhsm.interface_eth_2errors_input
(gauge)
Shown as error
aws.cloudhsm.interface_eth_2errors_input.sum
(count)
Shown as error
aws.cloudhsm.interface_eth_2errors_output
(gauge)
Shown as error
aws.cloudhsm.interface_eth_2errors_output.sum
(count)
Shown as error
aws.cloudhsm.interface_eth_2octets_input
(gauge)		Total input traffic to the HSM.
aws.cloudhsm.interface_eth_2octets_input.sum
(count)		Total sum of input traffic to the HSM.
aws.cloudhsm.interface_eth_2octets_output
(gauge)		Total output traffic to the HSM.
aws.cloudhsm.interface_eth_2octets_output.sum
(count)		Total sum of output traffic to the HSM.
aws.cloudhsm.interface_eth_2packets_input
(gauge)
Shown as packet
aws.cloudhsm.interface_eth_2packets_input.sum
(count)
Shown as packet
aws.cloudhsm.interface_eth_2packets_output
(gauge)
Shown as packet
aws.cloudhsm.interface_eth_2packets_output.sum
(count)
Shown as packet

Events

The AWS CloudHSM integration does not include any events.

Service Checks

The AWS CloudHSM integration does not include any service checks.

Troubleshooting

Need help? Contact Datadog support.

PREVIEWING: may/restructure-op-docs