--- title: AWS CloudHSM description: >- AWS CloudHSM is a service that provides hardware security modules for use in the AWS Cloud. breadcrumbs: Docs > Integrations > AWS CloudHSM --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). # AWS CloudHSM Integration version1.0.0 {% callout %} # Important note for users on the following Datadog sites: us2.ddog-gov.com {% alert level="info" %} To find out if this integration is available in your organization, see your [Datadog Integrations](https://app.datadoghq.com/integrations) page or ask your organization administrator. To initiate an exception request to enable this integration for your organization, email [support@ddog-gov.com](mailto:support@ddog-gov.com). {% /alert %} {% /callout %} ## Overview{% #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{% #setup %} ### Installation{% #installation %} If you haven't already, set up the [Amazon Web Services integration](https://docs.datadoghq.com/integrations/amazon_web_services.md) first. ### Metric collection{% #metric-collection %} 1. In the [AWS integration page](https://app.datadoghq.com/integrations/amazon-web-services), ensure that `CloudHSM` is enabled under the `Metric Collection` tab. 1. Install the [Datadog - AWS CloudHSM integration](https://app.datadoghq.com/integrations/amazon-cloudhsm). ### Log collection{% #log-collection %} #### Enable logging{% #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{% #send-logs-to-datadog %} 1. If you haven't already, set up the [Datadog Forwarder Lambda function](https://docs.datadoghq.com/logs/guide/forwarder.md). 1. 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: - [Add a manual trigger on the S3 bucket](https://docs.datadoghq.com/logs/guide/send-aws-services-logs-with-the-datadog-lambda-function.md#collecting-logs-from-s3-buckets) - [Add a manual trigger on the CloudWatch Log Group](https://docs.datadoghq.com/logs/guide/send-aws-services-logs-with-the-datadog-lambda-function.md#collecting-logs-from-cloudwatch-log-group) ## Data Collected{% #data-collected %} ### Metrics{% #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{% #events %} The AWS CloudHSM integration does not include any events. ### Service Checks{% #service-checks %} The AWS CloudHSM integration does not include any service checks. ## Troubleshooting{% #troubleshooting %} Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).