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 provides 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 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.
Note
The health indicators perform root cause analysis of non-green health statuses.
This can be computationally expensive when called frequently.
The HTTP address where the Logstash instance is accessible, including the port number.
idstring
A unique identifier (uuid) for the Logstash instance.
namestring
The name of the Logstash instance.
ephemeral_idstring
A unique identifier for the ephemeral session of the Logstash instance.
snapshotbooleannullable
statusenum
Health status of Logstash, based on the aggregated status of all indicators.
Statuses are:
green: Logstash is healthy.
unknown: Logstash health 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.
Values:greenredunknownyellow
symptomstring
timestampstring · format: date-time
The time at which this health report was generated, in ISO 8601 format with millisecond precision.
indicatorsobject
Information about the health of Logstash indicators.
pipelinesobject
statusenum
Health status of Logstash, based on the aggregated status of all indicators.
Statuses are:
green: Logstash is healthy.
unknown: Logstash health 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.
Values:greenredunknownyellow
symptomstring
indicatorsmapstring to object
<string>object
statusenum
Health status of Logstash, based on the aggregated status of all indicators.
Statuses are:
green: Logstash is healthy.
unknown: Logstash health 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.
Values:greenredunknownyellow
symptomstring
A message providing information about the current health status.
detailsobject
An object that contains additional information about the indicator that has led to the current health status result.
statusobject
stateenum
Values:LOADINGRUNNINGFINISHEDTERMINATED
flowobject
worker_utilizationobject
When the rate for a given flow metric window is infinite, it is presented as a string.
This occurs when the numerator metric has changed during the window without a change in the rate’s denominator metric.
currentunionnumber | enum
The most recent ~10s.
Values:Infinity
last_1_minuteunionnumber | enum
Values:Infinity
last_5_minutesunionnumber | enum
Values:Infinity
last_15_minutesunionnumber | enum
Values:Infinity
last_1_hourunionnumber | enum
Values:Infinity
last_24_hoursunionnumber | enum
Values:Infinity
lifetimeunionnumber | enum
The lifetime of the relevant pipeline or process.
Values:Infinity
recovery_logstring[]
If the pipeline has successfully recovered from a crash, include a list of timestamps
impactsobject[]
If a non-healthy status is returned, indicators may include a list of impacts that this health status will have on Logstash.
idstring
A unique identifier that may appear associated with a known impacts or issue.
This ID follows a structured format that helps identify the specific problem.
severityinteger · min: 1 · max: 10
How important this impact is to the functionality of Logstash. A value of 1 is the highest severity, with larger values indicating lower severity.
descriptionstring
A description of the impact on Logstash.
impact_areasstring[]
The areas of Logstash affected by the health status. Possible values are:
diagnosisobject[]
idstring
A unique identifier that may appear associated with a known diagnosis or issue.
This ID follows a structured format that helps identify the specific problem.
causestring
A description of a root cause of this health problem.
actionstring
A brief description of 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_urlstring · format: uri
A link to the troubleshooting guide that will fix the health problem.