Get the cluster health

  • GET /_health_report/{feature}
  • GET /_health_report
Auth

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.

Note

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.

Path parameters

feature union string | string[] optional

A feature of the cluster, as returned by the top-level health report API.

Leave it out to use /_health_report.

Query parameters

timeout string

Explicit operation timeout.

Reference
verbose boolean · default: true

Opt-in for more information about the health of the system.

size number · default: 1000

Limit the number of affected resources the health report API returns.

Response

application/json
cluster_name string required
indicators object required
master_is_stable object
status enum required
Values: green yellow red unknown unavailable
symptom string required
impacts object[]
description string required
id string required
impact_areas enum[] required
Values: search ingest backup deployment_management
severity number required
diagnosis object[]
id string required
action string required
affected_resources object required
indices union oneOf
One of: string[] or string
nodes object[]
name union string required nullable
One of: string
node_id union string required nullable
One of: string
slm_policies string[]
feature_states string[]
snapshot_repositories string[]
cause string required
help_url string required
details object
current_master object required
name union string required nullable
One of: string
node_id union string required nullable
One of: string
recent_masters object[] required
name union string required nullable
One of: string
node_id union string required nullable
One of: string
exception_fetching_history object
message string required
stack_trace string required
cluster_formation object[]
name string
node_id string required
cluster_formation_message string required
shards_availability object
status enum required
Values: green yellow red unknown unavailable
symptom string required
impacts object[]
description string required
id string required
impact_areas enum[] required
Values: search ingest backup deployment_management
severity number required
diagnosis object[]
Same fields as diagnosis in master_is_stable
details object
creating_primaries number required
creating_replicas number required
initializing_primaries number required
initializing_replicas number required
restarting_primaries number required
restarting_replicas number required
started_primaries number required
started_replicas number required
unassigned_primaries number required
unassigned_replicas number required
disk object
status enum required
Values: green yellow red unknown unavailable
symptom string required
impacts object[]
description string required
id string required
impact_areas enum[] required
Values: search ingest backup deployment_management
severity number required
diagnosis object[]
Same fields as diagnosis in master_is_stable
details object
indices_with_readonly_block number required
nodes_with_enough_disk_space number required
nodes_over_high_watermark number required
nodes_over_flood_stage_watermark number required
nodes_with_unknown_disk_status number required
repository_integrity object
status enum required
Values: green yellow red unknown unavailable
symptom string required
impacts object[]
description string required
id string required
impact_areas enum[] required
Values: search ingest backup deployment_management
severity number required
diagnosis object[]
Same fields as diagnosis in master_is_stable
details object
total_repositories number
corrupted_repositories number
corrupted string[]
data_stream_lifecycle object
status enum required
Values: green yellow red unknown unavailable
symptom string required
impacts object[]
description string required
id string required
impact_areas enum[] required
Values: search ingest backup deployment_management
severity number required
diagnosis object[]
Same fields as diagnosis in master_is_stable
details object
stagnating_backing_indices_count number required
total_backing_indices_in_error number required
stagnating_backing_indices object[]
index_name string required
first_occurrence_timestamp number required
retry_count number required
ilm object
status enum required
Values: green yellow red unknown unavailable
symptom string required
impacts object[]
description string required
id string required
impact_areas enum[] required
Values: search ingest backup deployment_management
severity number required
diagnosis object[]
Same fields as diagnosis in master_is_stable
details object
ilm_status enum required
Values: RUNNING STOPPING STOPPED
policies number required
stagnating_indices number required
slm object
status enum required
Values: green yellow red unknown unavailable
symptom string required
impacts object[]
description string required
id string required
impact_areas enum[] required
Values: search ingest backup deployment_management
severity number required
diagnosis object[]
Same fields as diagnosis in master_is_stable
details object
slm_status enum required
Values: RUNNING STOPPING STOPPED
policies number required
unhealthy_policies object
count number required
invocations_since_last_success map string to number
shards_capacity object
status enum required
Values: green yellow red unknown unavailable
symptom string required
impacts object[]
description string required
id string required
impact_areas enum[] required
Values: search ingest backup deployment_management
severity number required
diagnosis object[]
Same fields as diagnosis in master_is_stable
details object
data object required
max_shards_in_cluster number required
current_used_shards number
frozen object required
max_shards_in_cluster number required
current_used_shards number
file_settings object
status enum required
Values: green yellow red unknown unavailable
symptom string required
impacts object[]
description string required
id string required
impact_areas enum[] required
Values: search ingest backup deployment_management
severity number required
diagnosis object[]
Same fields as diagnosis in master_is_stable
details object
failure_streak number required
most_recent_failure string required
cluster_state_encryption object
status enum required
Values: green yellow red unknown unavailable
symptom string required
impacts object[]
description string required
id string required
impact_areas enum[] required
Values: search ingest backup deployment_management
severity number required
diagnosis object[]
Same fields as diagnosis in master_is_stable
details object
active_key_id string
active_password_id string required
encryption_required boolean required

Whether callers must refuse to store secrets when the service is not ready. If false, callers may fall back to storing secrets in plaintext (with a warning).

key_count number
metadata_password_id string
state string required
dlm_frozen_transitions object

Reports the health of data stream lifecycle transitions of backing indices to the frozen tier.

status enum required
Values: green yellow red unknown unavailable
symptom string required
impacts object[]
description string required
id string required
impact_areas enum[] required
Values: search ingest backup deployment_management
severity number required
diagnosis object[]
Same fields as diagnosis in master_is_stable
details object
transitions_enabled boolean

Indicates whether frozen-tier transitions are enabled by the dlm.frozen_transitions.enabled cluster setting.

service_running boolean

Indicates whether the frozen transition service is running on the current master node.

default_repository_configured boolean

Indicates whether a default snapshot repository is configured with the repositories.default_repository cluster setting.

overdue_indices_count number

The total number of overdue indices in the cluster.

overdue_indices_count_by_state map string to number

The number of overdue indices in the cluster for each transition state. Only present when there are overdue indices.

overdue_indices_sample object[]

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.

index_name string required

The name of the overdue index.

transition_state enum required

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: unmarked marked queued running
generated_at_millis number

The time, in milliseconds since the Unix epoch, when the master node generated the health snapshot. Only present when the indicator status is unknown, meaning the health snapshot is stale.

status enum
Values: green yellow red unknown unavailable