Ranger KMS Server Health Tests

Ranger KMS Server Audit Pipeline Test

This Ranger KMS Server health test checks that the Auditing for the Ranger KMS Server role is getting processed correctly and is not blocked.

A failure of this health test may indicate a problem with the audit pipeline of Ranger KMS Server process. This test can fail either because the Cloudera Audit Server is not accepting audits, or the Cloudera Manager Agent on the Ranger KMS Server 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 Ranger KMS Server monitoring setting.

Short Name: Audit Pipeline Test

Monitoring Period For Audit Failures

Description: The period to review when checking if audits are blocked and not getting processed.
Template Name: mgmt_navigator_failure_window
Default Value: 20
Unit(s): MINUTES

Navigator Audit Failure Thresholds

Description: 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.
Template Name: mgmt_navigator_failure_thresholds
Default Value: critical:any, warning:never
Unit(s): BYTES

Navigator Audit Pipeline Health Check

Description: 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.
Template Name: mgmt_navigator_status_check_enabled
Default Value: true
Unit(s): no unit

Ranger KMS Server File Descriptors

This Ranger KMS Server health test checks that the number of file descriptors used does not rise above some percentage of the Ranger KMS Server 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 Ranger KMS Server monitoring setting.

Short Name: File Descriptors

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Template Name: ranger_kms_server_fd_thresholds
Default Value: critical:70.0, warning:50.0
Unit(s): PERCENT

Ranger KMS Server Host Health

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

Short Name: Host Health

Ranger KMS Server Host Health Test

Description: When computing the overall Ranger KMS Server health, consider the host's health.
Template Name: ranger_kms_server_host_health_enabled
Default Value: true
Unit(s): no unit

Ranger KMS Server Log Directory Free Space

This Ranger KMS Server health test checks that the filesystem containing the log directory of this Ranger KMS Server 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 Ranger KMS Server monitoring settings.

Short Name: Log Directory Free Space

Log Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Template Name: log_directory_free_space_absolute_thresholds
Default Value: critical:5.36870912E9, warning:1.073741824E10
Unit(s): BYTES

Log Directory Free Space Monitoring Percentage Thresholds

Description: 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.
Template Name: log_directory_free_space_percentage_thresholds
Default Value: critical:never, warning:never
Unit(s): PERCENT

Ranger KMS Server Process Status

This Ranger KMS Server health test checks that the Cloudera Manager Agent on the Ranger KMS Server host is heart beating correctly and that the process associated with the Ranger KMS Server role is in the state expected by Cloudera Manager.

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

Short Name: Process Status

Ranger KMS Server Process Health Test

Description: Enables the health test that the Ranger KMS Server's process state is consistent with the role configuration
Template Name: ranger_kms_server_scm_health_enabled
Default Value: true
Unit(s): no unit

Ranger KMS Server Ranger KMS URL Canary Check

This is a Ranger KMS Server role-level status test that checks whether the Ranger KMS Server URL is reachable or not. A failure of this health check indicates that Ranger KMS Server URL is not reachable.

Short Name: Ranger KMS URL Canary Check

Ranger KMS Server Swap Memory Usage

This Ranger KMS Server 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

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Template Name: process_swap_memory_thresholds
Default Value: critical:never, warning:200.0
Unit(s): BYTES

Ranger KMS Server Unexpected Exits

This Ranger KMS Server health test checks that the Ranger KMS Server 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 Ranger KMS Server monitoring settings.

Short Name: Unexpected Exits

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Template Name: unexpected_exits_window
Default Value: 5
Unit(s): MINUTES

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Template Name: unexpected_exits_thresholds
Default Value: critical:any, warning:never
Unit(s): no unit