Get the cluster health
- GET /_health_report/{feature}
- GET /_health_report
Get a report with the health status of an Elasticsearch cluster. The report contains a list of indicators that compose Elasticsearch functionality.
Each indicator has a health status of: green, unknown, yellow or red. The indicator will provide an explanation and metadata describing the reason for its current health status.
The cluster’s status is controlled by the worst indicator status.
In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.
Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. The root cause and remediation steps are encapsulated in a diagnosis. A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.
The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.
Response
-
indicatorsobjectrequired -
dlm_frozen_transitionsobject -
Reports the health of data stream lifecycle transitions of backing indices to the frozen tier.
-
detailsobject -
transitions_enabledboolean -
Indicates whether frozen-tier transitions are enabled by the
dlm.frozen_transitions.enabledcluster setting. -
service_runningboolean -
Indicates whether the frozen transition service is running on the current master node.
-
default_repository_configuredboolean -
Indicates whether a default snapshot repository is configured with the
repositories.default_repositorycluster setting. -
overdue_indices_count_by_statemap string to number -
The number of overdue indices in the cluster for each transition state. Only present when there are overdue indices.
-
overdue_indices_sampleobject -
A sample of the overdue indices and their transition states, sorted by index name. The sample is limited to 100 indices for each transition state, so it can contain fewer indices than
overdue_indices_count. Only present when there are overdue indices. -
transition_staterequired -
The transition state of the overdue index.
Supported values include:
unmarked: The index is eligible for a frozen-tier transition but the data stream lifecycle has not marked it for conversion.marked: The index is marked for conversion but has not been submitted to the transition executor.queued: The index has been submitted to the transition executor and is waiting in its queue for a thread.running: The transition of the index is in progress.
-
Values:
unmarkedmarkedqueuedrunning