Key Management Server Proxy Health Tests

Key Management Server Proxy Audit Pipeline Test

This Key Management Server Proxy health test checks that the Auditing for the Key Management Server Proxy role is getting processed correctly and is not blocked. A failure of this health test may indicate a problem with the audit pipeline of Key Management Server Proxy process. This test can fail either because the Cloudera Audit Server is not accepting audits, or the Cloudera Manager Agent on the Key Management Server Proxy host isn't able to send audits because of some network issue. Check the Cloudera Manager Agent logs and Cloudera Audit Server logs for more details. This test can be enabled or disabled using the Navigator Audit Pipeline Health Check Key Management Server Proxy monitoring setting.

Short Name: Audit Pipeline Test

Property Name Description Template Name Default Value Unit
Monitoring Period For Audit Failures The period to review when checking if audits are blocked and not getting processed. mgmt_navigator_failure_window 20 MINUTES
Navigator Audit Failure Thresholds The health test thresholds for failures encountered when monitoring audits within a recent period specified by the mgmt_navigator_failure_window configuration for the role. The value that can be specified for this threshold is the number of bytes of audits data that is left to be sent to audit server. mgmt_navigator_failure_thresholds critical:any, warning:never BYTES
Navigator Audit Pipeline Health Check Enable test of audit events processing pipeline. This will test if audit events are not getting processed by Audit Server for a role that generates audit. mgmt_navigator_status_check_enabled true no unit

Key Management Server Proxy File Descriptors

This Key Management Server Proxy health test checks that the number of file descriptors used does not rise above some percentage of the Key Management Server Proxy file descriptor limit. A failure of this health test may indicate a bug in either Hadoop or Cloudera Manager. Contact Cloudera support. This test can be configured using the File Descriptor Monitoring Thresholds Key Management Server Proxy monitoring setting.

Short Name: File Descriptors

Property Name Description Template Name Default Value Unit
File Descriptor Monitoring Thresholds The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit. kms_keytrustee_fd_thresholds critical:70.0, warning:50.0 PERCENT

Key Management Server Proxy Host Health

This Key Management Server Proxy health test factors in the health of the host upon which the Key Management Server Proxy is running. A failure of this test means that the host running the Key Management Server Proxy is experiencing some problem. See that host's status page for more details.This test can be enabled or disabled using the Key Management Server Proxy Host Health Test Key Management Server Proxy monitoring setting.

Short Name: Host Health

Property Name Description Template Name Default Value Unit
Key Management Server Proxy Host Health Test When computing the overall Key Management Server Proxy health, consider the host's health. kms_keytrustee_host_health_enabled true no unit

Key Management Server Proxy Log Directory Free Space

This Key Management Server Proxy health test checks that the filesystem containing the log directory of this Key Management Server Proxy has sufficient free space. This test can be configured using the Log Directory Free Space Monitoring Absolute Thresholds and Log Directory Free Space Monitoring Percentage Thresholds Key Management Server Proxy monitoring settings.

Short Name: Log Directory Free Space

Property Name Description Template Name Default Value Unit
Log Directory Free Space Monitoring Absolute Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. log_directory_free_space_absolute_thresholds critical:5.36870912E9, warning:1.073741824E10 BYTES
Log Directory Free Space Monitoring Percentage Thresholds The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured. log_directory_free_space_percentage_thresholds critical:never, warning:never PERCENT

Key Management Server Proxy Process Status

This Key Management Server Proxy health test checks that the Cloudera Manager Agent on the Key Management Server Proxy host is heart beating correctly and that the process associated with the Key Management Server Proxy role is in the state expected by Cloudera Manager. A failure of this health test may indicate a problem with the Key Management Server Proxy process, a lack of connectivity to the Cloudera Manager Agent on the Key Management Server Proxy host, or a problem with the Cloudera Manager Agent. This test can fail either because the Key Management Server Proxy has crashed or because the Key Management Server Proxy will not start or stop in a timely fashion. Check the Key Management Server Proxy logs for more details. If the test fails because of problems communicating with the Cloudera Manager Agent on the Key Management Server Proxy host, check the status of the Cloudera Manager Agent by running /etc/init.d/cloudera-scm-agent status on the Key Management Server Proxy host, or look in the Cloudera Manager Agent logs on the Key Management Server Proxy host for more details. This test can be enabled or disabled using the Key Management Server Proxy Process Health Test Key Management Server Proxy monitoring setting.

Short Name: Process Status

Property Name Description Template Name Default Value Unit
Key Management Server Proxy Process Health Test Enables the health test that the Key Management Server Proxy's process state is consistent with the role configuration kms_keytrustee_scm_health_enabled true no unit

Key Management Server Proxy Swap Memory Usage

This Key Management Server Proxy health test checks the amount of swap memory in use by the role. A failure of this health test may indicate that your machine is overloaded. This test can be configured using the Process Swap Memory Thresholds monitoring settings.

Short Name: Swap Memory Usage

Property Name Description Template Name Default Value Unit
Process Swap Memory Thresholds The health test thresholds on the swap memory usage of the process. process_swap_memory_thresholds critical:never, warning:any BYTES

Key Management Server Proxy Unexpected Exits

This Key Management Server Proxy health test checks that the Key Management Server Proxy has not recently exited unexpectedly. The test returns "Bad" health if the number of unexpected exits exceeds a critical threshold. For example, if this test is configured with a critical threshold of 1, this test returns "Good" health if there have been no unexpected exits recently. If 1 or more unexpected exits occured recently, this test returns "Bad" health. The test also indicates whether any of the exits were caused by an OutOfMemory error if the Cloudera Manager Kill When Out of Memory monitoring setting is enabled. This test can be configured using the Unexpected Exits Thresholds and Unexpected Exits Monitoring Period Key Management Server Proxy monitoring settings.

Short Name: Unexpected Exits

Property Name Description Template Name Default Value Unit
Unexpected Exits Monitoring Period The period to review when computing unexpected exits. unexpected_exits_window 5 MINUTES
Unexpected Exits Thresholds The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role. unexpected_exits_thresholds critical:any, warning:never no unit