Health report API

edit

An API that reports the health status of Logstash.

curl -XGET 'localhost:9600/_health_report?pretty'

Description

edit

The health API returns a report with the health status of Logstash and the pipelines that are running inside of it. The report contains a list of indicators that compose Logstash 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 top-level 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, and the URL for detailed troubleshooting help.

The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently.

Response body

edit
status

(Optional, string) Health status of Logstash, based on the aggregated status of all indicators. Statuses are:

green
Logstash is healthy.
unknown
The health of Logstash could not be determined.
yellow
The functionality of Logstash is in a degraded state and may need remediation to avoid the health becoming red.
red
Logstash is experiencing an outage or certain features are unavailable for use.
indicators

(object) Information about the health of the Logstash indicators.

Properties of indicators
<indicator>

(object) Contains health results for an indicator.

Properties of <indicator>
status

(string) Health status of the indicator. Statuses are:

green
The indicator is healthy.
unknown
The health of the indicator could not be determined.
yellow
The functionality of an indicator is in a degraded state and may need remediation to avoid the health becoming red.
red
The indicator is experiencing an outage or certain features are unavailable for use.
symptom
(string) A message providing information about the current health status.
details
(Optional, object) An object that contains additional information about the indicator that has lead to the current health status result. Each indicator has a unique set of details.
impacts

(Optional, array) If a non-healthy status is returned, indicators may include a list of impacts that this health status will have on Logstash.

Properties of impacts
severity
(integer) How important this impact is to the functionality of Logstash. A value of 1 is the highest severity, with larger values indicating lower severity.
description
(string) A description of the impact on Logstash.
impact_areas

(array of strings) The areas Logstash functionality that this impact affects. Possible values are:

  • pipeline_execution
diagnosis

(Optional, array) If a non-healthy status is returned, indicators may include a list of diagnosis that encapsulate the cause of the health issue and an action to take in order to remediate the problem.

Properties of diagnosis
cause
(string) A description of a root cause of this health problem.
action
(string) A brief description the steps that should be taken to remediate the problem. A more detailed step-by-step guide to remediate the problem is provided by the help_url field.
help_url
(string) A link to the troubleshooting guide that’ll fix the health problem.

Indicator Details

edit

Each health indicator in the health API returns a set of details that further explains the state of the system. The details have contents and a structure that is unique to each indicator.

Pipeline Indicator Details

edit
pipelines/indicators/<pipeline_id>/details

(object) Information about the specified pipeline.

Properties of pipelines/indicators/<pipeline_id>/details
status

(object) Details related to the pipeline’s current status and run-state.

Properties of status
state
(string) The current state of the pipeline, including whether it is loading, running, finished, or terminated.