Solr Server Health Tests

Solr Server Audit Pipeline Test

This Solr Server health test checks that the Auditing for the Solr 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 Solr Server process. This test can fail either because the Cloudera Audit Server is not accepting audits, or the Cloudera Manager Agent on the Solr 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 Solr Server 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

Solr Server File Descriptors

This Solr Server health test checks that the number of file descriptors used does not rise above some percentage of the Solr 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 Solr Server 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. solr_server_fd_thresholds critical:70.0, warning:50.0 PERCENT

Solr Server GC Duration

This Solr Server health test checks that the Solr Server is not spending too much time performing Java garbage collection. It checks that no more than some percentage of recent time is spent performing Java garbage collection. A failure of this health test may indicate a capacity planning problem or misconfiguration of the Solr Server. This test can be configured using the Garbage Collection Duration Thresholds and Garbage Collection Duration Monitoring Period Solr Server monitoring settings.

Short Name: GC Duration

Property Name Description Template Name Default Value Unit
Garbage Collection Duration Monitoring Period The period to review when computing the moving average of garbage collection time. solr_server_gc_duration_window 5 MINUTES
Garbage Collection Duration Thresholds The health test thresholds for the weighted average time spent in Java garbage collection. Specified as a percentage of elapsed wall clock time. solr_server_gc_duration_thresholds critical:60.0, warning:30.0 no unit

Solr Server Heap Dump Directory Free Space

This Solr Server health test checks that the filesystem containing the heap dump directory of this Solr Server has sufficient free space. This test can be configured using the Heap Dump Directory Free Space Monitoring Absolute Thresholds and Heap Dump Directory Free Space Monitoring Percentage Thresholds Solr Server monitoring settings.

Short Name: Heap Dump Directory Free Space

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

Solr Server Host Health

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

Short Name: Host Health

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

Solr Server Log Directory Free Space

This Solr Server health test checks that the filesystem containing the log directory of this Solr 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 Solr Server 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

Solr Server Process Status

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

Short Name: Process Status

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

Solr Server Solr Server API Liveness

This is a Solr Server health test that checks that the Solr Server is responding quickly to API requests by the Cloudera Manager Agent to collect the status of the Solr Server's Solr cores. A failure of this health test may indicate a problem with the Solr Server, a misconfiguration of the Solr Server or a problem with the Cloudera Manager Agent. Consult the Cloudera Manager Agent logs and the logs of the Solr Server for more details. If the test's failure message indicates a communication problem, this means that the Cloudera Manager Agent's HTTP requests to the Solr Server are failing or timing out. These requests are completely local to the Solr Server's host, and so should never fail under normal conditions. If the test's failure message indicates an unexpected response, then the Solr Server responded to the Cloudera Manager Agent's request, but the Cloudera Manager Agent could not interpret the response for some reason. This test can be enabled or disabled using the Solr Server API Liveness Solr Server monitoring setting and can be configured using the Solr Server API Liveness Request Duration monitoring setting.

Short Name: Solr Server API Liveness

Property Name Description Template Name Default Value Unit
Solr Server API Liveness Enables the health test that the Cloudera Manager Agent can successfully contact and gather status of Solr Cores from the Solr Server with a simple API request. solr_core_status_collection_health_enabled true no unit
Solr Server API Liveness Request Duration The health test thresholds on the duration of the Solr Server API request. solr_core_status_collection_thresholds critical:never, warning:10000.0 MILLISECONDS

Solr Server Swap Memory Usage

This Solr 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

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

Solr Server Unexpected Exits

This Solr Server health test checks that the Solr 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 Solr Server 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

Solr Server Web Server Status

This health test checks that the role's web server is responding quickly to requests by the Cloudera Manager Agent, and that the Cloudera Manager Agent can collect metrics from the web server. Failure of this health test may indicate a problem with the web server of the Solr Server, a misconfiguration of the Solr Server, or a problem with the Cloudera Manager Agent. Consult the Cloudera Manager Agent logs and the logs of the Solr Server for more detail. If the test failure message indicates a communication problem, the Cloudera Manager Agent's HTTP requests to the Solr Server's web server are failing or timing out. If the test's failure message indicates an unexpected response, the Solr Server's web server responded to the Cloudera Manager Agent's request, but the response could not be interpreted for some reason. This test can be configured using the Web Metric Collection Solr Server monitoring setting.

Short Name: Web Server Status

Property Name Description Template Name Default Value Unit
Web Metric Collection Enables the health test that the Cloudera Manager Agent can successfully contact and gather metrics from the web server. solr_server_web_metric_collection_enabled true no unit
Web Metric Collection Duration The health test thresholds on the duration of the metrics request to the web server. solr_server_web_metric_collection_thresholds critical:never, warning:10000.0 MILLISECONDS