---
type: api
title: Get health status
description: The health API returns a report with the health status of Logstash and the pipelines that are running inside of it.
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/logstash/operation/operation-healthreport
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/logstash/operation/operation-healthreport
products:
  - Logstash
---

# Get health status

- Server: `/`

## Paths

- `GET` `/_health_report`

- [Basic auth](/elastic/docs-builder/docs/4371/api/doc/logstash/authentication#basicauth)

## Description

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.

## Query String Parameters

- `pretty` (boolean)
  If you append `?pretty=true` to the request, the JSON returned will be pretty formatted. Use it for debugging only!

## Response

Indicates a successful call

`application/json`

- `host` (string)
  The name of the host machine.
- `version` (string)
  The version of the Logstash instance.
- `http_address` (string)
  The HTTP address where the Logstash instance is accessible, including the port number.
- `id` (string)
  A unique identifier (uuid) for the Logstash instance.
- `name` (string)
  The name of the Logstash instance.
- `ephemeral_id` (string)
  A unique identifier for the ephemeral session of the Logstash instance.
- `snapshot` (boolean) — nullable
- `status` (enum Status)
  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: `green`, `red`, `unknown`, `yellow`
- `symptom` (string)
- `timestamp` (string)
  The time at which this health report was generated, in ISO 8601 format with millisecond precision.
- `indicators` (object)
  Information about the health of Logstash indicators.
  - `pipelines` (object)
    - `status` (enum Status)
      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: `green`, `red`, `unknown`, `yellow`
    - `symptom` (string)
    - `indicators` (map string to object)
      Map values (object)
      - `status` (enum Status)
        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: `green`, `red`, `unknown`, `yellow`
      - `symptom` (string)
        A message providing information about the current health status.
      - `details` (object)
        An object that contains additional information about the indicator that has led to the current health status result.
        - `status` (object)
          - `state` (enum)
            Values: `LOADING`, `RUNNING`, `FINISHED`, `TERMINATED`
        - `flow` (object)
          - `worker_utilization` ({} FlowWindows)
            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.
            - `current` (union number | enum)
              The most recent ~10s.
              Values: `Infinity`
            - `last_1_minute` (union number | enum)
              Values: `Infinity`
            - `last_5_minutes` (union number | enum)
              Values: `Infinity`
            - `last_15_minutes` (union number | enum)
              Values: `Infinity`
            - `last_1_hour` (union number | enum)
              Values: `Infinity`
            - `last_24_hours` (union number | enum)
              Values: `Infinity`
            - `lifetime` (union number | enum)
              The lifetime of the relevant pipeline or process.
              Values: `Infinity`
        - `recovery_log` ([] string)
          If the pipeline has successfully recovered from a crash, include a list of timestamps
      - `impacts` ([] object)
        If a non-healthy status is returned, indicators may include a list of impacts that this health status will have on Logstash.
        - `id` (string)
          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.
        - `severity` (integer · 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.
        - `description` (string)
          A description of the impact on Logstash.
        - `impact_areas` ([] string)
          The areas of Logstash affected by the health status. Possible values are:
      - `diagnosis` ([] object)
        - `id` (string)
          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.
        - `cause` (string)
          A description of a root cause of this health problem.
        - `action` (string)
          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_url` (string)
          A link to the troubleshooting guide that will fix the health problem.
## Code Examples

#### Console

```console
GET /_health_report
```

#### curl

```curl
curl -X GET "/_health_report"
```

## Response Examples

#### Normal terminated case

The pipeline has finished without errors or interruptions.

```json
{
  "timestamp": "2026-08-12T10:30:45.123456789Z",
  "symptom": "1 indicator is concerning (\u0060pipelines\u0060)",
  "indicators": {
    "pipelines": {
      "status": "yellow",
      "symptom": "1 indicator is concerning (\u0060normal-completion-pipeline\u0060)",
      "indicators": {
        "normal-completion-pipeline": {
          "status": "yellow",
          "symptom": "The pipeline is concerning; 1 area is impacted and 1 diagnosis is available",
          "diagnosis": [
            {
              "cause": "pipeline has finished running because its inputs have been closed and events have been processed",
              "action": "if you expect this pipeline to run indefinitely, you will need to configure its inputs to continue receiving or fetching events"
            }
          ],
          "impacts": [
            {
              "impact_areas": [
                "pipeline_execution"
              ]
            }
          ],
          "details": {
            "status": {
              "state": "FINISHED"
            }
          }
        }
      }
    }
  }
}
```

#### Abnormal terminated case

The pipeline is terminated with errors.

```json
{
  "timestamp": "2026-08-12T10:30:45.123456789Z",
  "status": "red",
  "symptom": "1 indicator is unhealthy (\u0060pipelines\u0060)",
  "indicators": {
    "pipelines": {
      "status": "red",
      "symptom": "1 indicator is unhealthy (\u0060abnormal-termination-pipeline\u0060)",
      "indicators": {
        "abnormal-termination-pipeline": {
          "status": "red",
          "symptom": "The pipeline is unhealthy; 1 area is impacted and 1 diagnosis is available",
          "diagnosis": [
            {
              "cause": "pipeline is not running, likely because it has encountered an error",
              "action": "view logs to determine the cause of abnormal pipeline shutdown"
            }
          ],
          "impacts": [
            {
              "description": "the pipeline is not currently processing",
              "impact_areas": [
                "pipeline_execution"
              ]
            }
          ],
          "details": {
            "status": {
              "state": "TERMINATED"
            }
          }
        }
      }
    }
  }
}
```

#### Backpressure case

A pipeline is blocked by slow downstream processing.

```json
{
  "timestamp": "2026-08-12T10:30:45.123456789Z",
  "status": "red",
  "symptom": "1 indicator is unhealthy (\u0060pipelines\u0060)",
  "indicators": {
    "pipelines": {
      "status": "red",
      "symptom": "1 indicator is unhealthy (\u0060blocked-pipeline\u0060)",
      "indicators": {
        "blocked-pipeline": {
          "status": "red",
          "symptom": "The pipeline is unhealthy; 1 area is impacted and 1 diagnosis is available",
          "diagnosis": [
            {
              "id": "logstash:health:pipeline:flow:worker_utilization:diagnosis:5m-blocked",
              "cause": "pipeline workers have been completely blocked for at least five minutes",
              "action": "address bottleneck or add resources"
            }
          ],
          "impacts": [
            {
              "id": "logstash:health:pipeline:flow:impact:blocked_processing",
              "severity": 1,
              "description": "the pipeline is blocked",
              "impact_areas": [
                "pipeline_execution"
              ]
            }
          ],
          "details": {
            "status": {
              "state": "RUNNING"
            },
            "flow": {
              "worker_utilization": {
                "last_1_minute": 100,
                "last_5_minutes": 100
              }
            }
          }
        }
      }
    }
  }
}
```

#### Recovery case

A pipeline has recently recovered from a crash

```json
{
  "timestamp": "2026-08-12T10:30:45.123456789Z",
  "status": "yellow",
  "symptom": "1 indicator is unhealthy (\u0060pipelines\u0060)",
  "indicators": {
    "pipelines": {
      "status": "yellow",
      "symptom": "1 indicator is concerning (\u0060crashy-pipeline\u0060)",
      "indicators": {
        "crashy-pipeline": {
          "status": "yellow",
          "symptom": "The pipeline is concerning; 1 area is impacted and 1 diagnosis is available",
          "diagnosis": [
            {
              "id": "logstash:health:pipeline:recovery:diagnosis:5m-recovery-recent",
              "cause": "pipeline has recovered from crashes 1 time in the last 5 minutes",
              "action": "inspect logs to determine source of crash"
            }
          ],
          "impacts": [
            {
              "id": "logstash:health:pipeline:recovery:impact:intermittent_processing",
              "severity": 2,
              "description": "the pipeline recently recovered from a crash",
              "impact_areas": [
                "pipeline_execution"
              ]
            }
          ],
          "details": {
            "status": {
              "state": "RUNNING"
            },
            "flow": {
              "worker_utilization": {
                "last_1_minute": 0.1,
                "last_5_minutes": 0.1
              }
            },
            "recovery_log": [
              "2026-04-01T21:12:04.498144Z"
            ]
          }
        }
      }
    }
  }
}
```