Authentication

Basic auth (http)

Basic auth tokens are constructed with the Basic keyword, followed by a space, followed by a base64-encoded string of your username:password (separated by a : colon).

Example: send a Authorization: Basic aGVsbG86aGVsbG8= HTTP header with your requests to authenticate with the API.

Get hot threads

GET /_node/hot_threads

Basic auth

Get information about current hot threads for Logstash. A hot thread is a Java thread that has high CPU usage and takes longer than normal to execute.

Query parameters

threads integer

The number of hot threads to return.

Default value is 10.
stacktrace_size integer

The depth of the stack trace to report for each thread.

Default value is 50.
ignore_idle_threads boolean

If true, does not return idle threads.

Default value is true.
pretty boolean

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

If you append ?human=true to the request, the JSON returned will be in a human-readable format.

Responses

200 application/json

Indicates a successful call
Hide response attribute Show response attribute object
- hot_threads object
  
  Hide hot_threads attributes Show hot_threads attributes object
  
  time string
  
  busiest_threads integer
  
  threads array[object]
  
  Hide threads attributes Show threads attributes object
  
  name string
  
  thread_id integer
  
  percent_of_cpu_time number(double)
  
  state string
  
  traces array[string]

GET /_node/hot_threads

curl \
 --request GET 'http://api.example.com/_node/hot_threads' \
 --user "username:password"

Response examples (200)

{
  "hot_threads": {
    "time": "2025-01-06T18:25:28-07:00",
    "threads": [
      {
        "name": "Ruby-0-Thread-7",
        "state": "timed_waiting",
        "traces": [
          "java.lang.Object.wait(Native Method)",
          "org.jruby.RubyThread.sleep(RubyThread.java:1002)",
          "org.jruby.RubyKernel.sleep(RubyKernel.java:803)"
        ],
        "thread_id": 37,
        "percent_of_cpu_time": 0.0
      },
      {
        "name": "[test2]>worker3",
        "state": "waiting",
        "traces": [
          "sun.misc.Unsafe.park(Native Method)",
          "java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)",
          "java.util.concurrent.locks.AbstractQueuedSynchronizer.parkAndCheckInterrupt(AbstractQueuedSynchronizer.java:836)"
        ],
        "thread_id": 10,
        "percent_of_cpu_time": 0.85
      },
      {
        "name": "[test2]>worker2",
        "state": "runnable",
        "traces": [
          "org.jruby.RubyClass.allocate(RubyClass.java:225)",
          "org.jruby.RubyClass.newInstance(RubyClass.java:856)",
          "org.jruby.RubyClass$INVOKER$i$newInstance.call(RubyClass$INVOKER$i$newInstance.gen)"
        ],
        "thread_id": 11,
        "percent_of_cpu_time": 0.85
      }
    ],
    "busiest_threads": 3
  }
}

Get node statistics

GET /_node/stats

Basic auth

Get node statistics including information about the JVM, process, events, flow, and queue.

Query parameters

pretty boolean

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

Responses

200 application/json

A JSON object containing pipelines statistics.
Hide response attributes Show response attributes object
- 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 | null
- status string
  
  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 are green, red, unknown, or yellow.
- pipeline object
  
  Hide pipeline attributes Show pipeline attributes object
  
  workers integer
  
  batch_size integer
  
  batch_delay integer
- jvm object
  
  Hide jvm attributes Show jvm attributes object
  
  threads object
  
  Hide threads attributes Show threads attributes object
  
  count integer
  
  The number of active JVM threads.
  
  peak_count integer
  
  The peak number of active JVM threads.
  
  mem object
  
  Hide mem attributes Show mem attributes object
  
  heap_used_percent integer
  
  The percentage of heap memory used.
  
  heap_committed_in_bytes integer(int64)
  
  The committed heap memory in bytes.
  
  heap_max_in_bytes integer(int64)
  
  The maximum heap memory in bytes.
  
  heap_used_in_bytes integer(int64)
  
  The used heap memory in bytes.
  
  non_heap_used_in_bytes integer(int64)
  
  The used non-heap memory in bytes.
  
  non_heap_committed_in_bytes integer(int64)
  
  The committed non-heap memory in bytes.
  
  pools object
  
  Hide pools attributes Show pools attributes object
  
  survivor object
  
  Hide survivor attributes Show survivor attributes object
  
  peak_used_in_bytes integer(int64)
  
  used_in_bytes integer(int64)
  
  peak_max_in_bytes integer(int64)
  
  max_in_bytes integer(int64)
  
  committed_in_bytes integer(int64)
  
  old object
  
  Hide old attributes Show old attributes object
  
  peak_used_in_bytes integer(int64)
  
  used_in_bytes integer(int64)
  
  peak_max_in_bytes integer(int64)
  
  max_in_bytes integer(int64)
  
  committed_in_bytes integer(int64)
  
  young object
  
  Hide young attributes Show young attributes object
  
  peak_used_in_bytes integer(int64)
  
  used_in_bytes integer(int64)
  
  peak_max_in_bytes integer(int64)
  
  max_in_bytes integer(int64)
  
  committed_in_bytes integer(int64)
  
  gc object
  
  Hide gc attribute Show gc attribute object
  
  collectors object
  
  Hide collectors attributes Show collectors attributes object
  
  old object
  
  Hide old attributes Show old attributes object
  
  collection_time_in_millis integer(int64)
  
  collection_count integer
  
  young object
  
  Hide young attributes Show young attributes object
  
  collection_time_in_millis integer(int64)
  
  collection_count integer
  
  uptime_in_millis integer(int64)
  
  The JVM uptime in milliseconds.
- process object
  
  Hide process attributes Show process attributes object
  
  open_file_descriptors integer
  
  peak_open_file_descriptors integer
  
  max_file_descriptors integer
  
  mem object
  
  Hide mem attribute Show mem attribute object
  
  total_virtual_in_bytes integer
  
  cpu object
  
  Hide cpu attributes Show cpu attributes object
  
  total_in_millis integer
  
  percent integer
  
  load_average object
  
  Hide load_average attribute Show load_average attribute object
  
  1m number
- events object
  
  Hide events attributes Show events attributes object
  
  in integer(int64)
  
  filtered integer(int64)
  
  out integer(int64)
  
  duration_in_millis integer(int64)
  
  queue_push_duration_in_millis integer(int64)
- flow object
  
  Hide flow attributes Show flow attributes object
  
  input_throughput object
  
  This metric is expressed in events-per-second, and is the rate of events being pushed into the pipeline(s) queue(s) relative to wall-clock time (events.in / second). It includes events that are blocked by the queue and have not yet been accepted.
  
  Hide input_throughput attributes Show input_throughput attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  filter_throughput object
  
  This metric is expressed in events-per-second, and is the rate of events flowing through the filter phase of the pipeline(s) relative to wall-clock time (events.filtered / second).
  
  Hide filter_throughput attributes Show filter_throughput attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  output_throughput object
  
  This metric is expressed in events-per-second, and is the rate of events flowing through the output phase of the pipeline(s) relative to wall-clock time (events.out / second).
  
  Hide output_throughput attributes Show output_throughput attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  queue_backpressure object
  
  This is a unitless metric representing the cumulative time spent by all inputs blocked pushing events into their pipeline’s queue, relative to wall-clock time (queue_push_duration_in_millis / millisecond). It is typically most useful when looking at the stats for an individual pipeline.
  
  While a "zero" value indicates no back-pressure to the queue, the magnitude of this metric is highly dependent on the shape of the pipelines and their inputs. It cannot be used to compare one pipeline to another or even one process to itself if the quantity or shape of its pipelines changes. A pipeline with only one single-threaded input may contribute up to 1.00, a pipeline whose inputs have hundreds of inbound connections may contribute much higher numbers to this combined value.
  
  Additionally, some amount of back-pressure is both normal and expected for pipelines that are pulling data, as this back-pressure allows them to slow down and pull data at a rate its downstream pipeline can tolerate.
  
  Hide queue_backpressure attributes Show queue_backpressure attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  worker_concurrency object
  
  This is a unitless metric representing the cumulative time spent by all workers relative to wall-clock time (duration_in_millis / millisecond).
  
  A pipeline is considered "saturated" when its worker_concurrency flow metric approaches its available pipeline.workers, because it indicates that all of its available workers are being kept busy. Tuning a saturated pipeline to have more workers can often work to increase that pipeline’s throughput and decrease back-pressure to its queue, unless the pipeline is experiencing back-pressure from its outputs.
  
  A process is also considered "saturated" when its top-level worker_concurrency flow metric approaches the cumulative pipeline.workers across all pipelines, and similarly can be addressed by tuning the individual pipelines that are saturated.
  
  Hide worker_concurrency attributes Show worker_concurrency attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
- pipelines object
  
  A map where each key is a user-defined pipeline name, and the value contains the metrics for that pipeline.
  
  Hide pipelines attribute Show pipelines attribute object
  
  * object Additional properties
  
  Metrics of each plugin in the pipeline, flow statistics, event statistics and queue statistics.
  
  Hide * attributes Show * attributes object
  
  events object
  
  Hide events attributes Show events attributes object
  
  in integer(int64)
  
  filtered integer(int64)
  
  out integer(int64)
  
  duration_in_millis integer(int64)
  
  queue_push_duration_in_millis integer(int64)
  
  flow object
  
  One of:
  PipelineMQFlowStats object PipelinePQFlowStats object
  
  Hide attributes Show attributes
  
  input_throughput object
  
  This metric is expressed in events-per-second, and is the rate of events being pushed into the pipeline(s) queue(s) relative to wall-clock time (events.in / second). It includes events that are blocked by the queue and have not yet been accepted.
  
  Hide input_throughput attributes Show input_throughput attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  filter_throughput object
  
  This metric is expressed in events-per-second, and is the rate of events flowing through the filter phase of the pipeline(s) relative to wall-clock time (events.filtered / second).
  
  Hide filter_throughput attributes Show filter_throughput attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  output_throughput object
  
  This metric is expressed in events-per-second, and is the rate of events flowing through the output phase of the pipeline(s) relative to wall-clock time (events.out / second).
  
  Hide output_throughput attributes Show output_throughput attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  queue_backpressure object
  
  This is a unitless metric representing the cumulative time spent by all inputs blocked pushing events into their pipeline’s queue, relative to wall-clock time (queue_push_duration_in_millis / millisecond). It is typically most useful when looking at the stats for an individual pipeline.
  
  While a "zero" value indicates no back-pressure to the queue, the magnitude of this metric is highly dependent on the shape of the pipelines and their inputs. It cannot be used to compare one pipeline to another or even one process to itself if the quantity or shape of its pipelines changes. A pipeline with only one single-threaded input may contribute up to 1.00, a pipeline whose inputs have hundreds of inbound connections may contribute much higher numbers to this combined value.
  
  Additionally, some amount of back-pressure is both normal and expected for pipelines that are pulling data, as this back-pressure allows them to slow down and pull data at a rate its downstream pipeline can tolerate.
  
  Hide queue_backpressure attributes Show queue_backpressure attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  worker_concurrency object
  
  This is a unitless metric representing the cumulative time spent by all workers relative to wall-clock time (duration_in_millis / millisecond).
  
  A pipeline is considered "saturated" when its worker_concurrency flow metric approaches its available pipeline.workers, because it indicates that all of its available workers are being kept busy. Tuning a saturated pipeline to have more workers can often work to increase that pipeline’s throughput and decrease back-pressure to its queue, unless the pipeline is experiencing back-pressure from its outputs.
  
  A process is also considered "saturated" when its top-level worker_concurrency flow metric approaches the cumulative pipeline.workers across all pipelines, and similarly can be addressed by tuning the individual pipelines that are saturated.
  
  Hide worker_concurrency attributes Show worker_concurrency attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  worker_utilization object
  
  This is a unitless metric that indicates the percentage of available worker time being used by this individual plugin (duration / (uptime * pipeline.workers). It is useful for identifying which plugins in a pipeline are using the available worker resources.
  
  A pipeline is considered "saturated" when worker_utilization approaches 100, because it indicates that all of its workers are being kept busy. This is typically an indication of either downstream back-pressure or insufficient resources allocated to the pipeline. Tuning a saturated pipeline to have more workers can often work to increase that pipeline’s throughput and decrease back-pressure to its queue, unless the pipeline is experiencing back-pressure from its outputs.
  
  A pipeline is considered "starved" when worker_utilization approaches 0, because it indicates that none of its workers are being kept busy. This is typically an indication that the inputs are not receiving or retrieving enough volume to keep the pipeline workers busy. Tuning a starved pipeline to have fewer workers can help it to consume less memory and CPU, freeing up resources for other pipelines.
  
  Hide worker_utilization attributes Show worker_utilization attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  Hide attributes Show attributes
  
  input_throughput object
  
  This metric is expressed in events-per-second, and is the rate of events being pushed into the pipeline(s) queue(s) relative to wall-clock time (events.in / second). It includes events that are blocked by the queue and have not yet been accepted.
  
  Hide input_throughput attributes Show input_throughput attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  filter_throughput object
  
  This metric is expressed in events-per-second, and is the rate of events flowing through the filter phase of the pipeline(s) relative to wall-clock time (events.filtered / second).
  
  Hide filter_throughput attributes Show filter_throughput attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  output_throughput object
  
  This metric is expressed in events-per-second, and is the rate of events flowing through the output phase of the pipeline(s) relative to wall-clock time (events.out / second).
  
  Hide output_throughput attributes Show output_throughput attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  queue_backpressure object
  
  This is a unitless metric representing the cumulative time spent by all inputs blocked pushing events into their pipeline’s queue, relative to wall-clock time (queue_push_duration_in_millis / millisecond). It is typically most useful when looking at the stats for an individual pipeline.
  
  While a "zero" value indicates no back-pressure to the queue, the magnitude of this metric is highly dependent on the shape of the pipelines and their inputs. It cannot be used to compare one pipeline to another or even one process to itself if the quantity or shape of its pipelines changes. A pipeline with only one single-threaded input may contribute up to 1.00, a pipeline whose inputs have hundreds of inbound connections may contribute much higher numbers to this combined value.
  
  Additionally, some amount of back-pressure is both normal and expected for pipelines that are pulling data, as this back-pressure allows them to slow down and pull data at a rate its downstream pipeline can tolerate.
  
  Hide queue_backpressure attributes Show queue_backpressure attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  worker_concurrency object
  
  This is a unitless metric representing the cumulative time spent by all workers relative to wall-clock time (duration_in_millis / millisecond).
  
  A pipeline is considered "saturated" when its worker_concurrency flow metric approaches its available pipeline.workers, because it indicates that all of its available workers are being kept busy. Tuning a saturated pipeline to have more workers can often work to increase that pipeline’s throughput and decrease back-pressure to its queue, unless the pipeline is experiencing back-pressure from its outputs.
  
  A process is also considered "saturated" when its top-level worker_concurrency flow metric approaches the cumulative pipeline.workers across all pipelines, and similarly can be addressed by tuning the individual pipelines that are saturated.
  
  Hide worker_concurrency attributes Show worker_concurrency attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  worker_utilization object
  
  This is a unitless metric that indicates the percentage of available worker time being used by this individual plugin (duration / (uptime * pipeline.workers). It is useful for identifying which plugins in a pipeline are using the available worker resources.
  
  A pipeline is considered "saturated" when worker_utilization approaches 100, because it indicates that all of its workers are being kept busy. This is typically an indication of either downstream back-pressure or insufficient resources allocated to the pipeline. Tuning a saturated pipeline to have more workers can often work to increase that pipeline’s throughput and decrease back-pressure to its queue, unless the pipeline is experiencing back-pressure from its outputs.
  
  A pipeline is considered "starved" when worker_utilization approaches 0, because it indicates that none of its workers are being kept busy. This is typically an indication that the inputs are not receiving or retrieving enough volume to keep the pipeline workers busy. Tuning a starved pipeline to have fewer workers can help it to consume less memory and CPU, freeing up resources for other pipelines.
  
  Hide worker_utilization attributes Show worker_utilization attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  queue_persisted_growth_bytes object
  
  This metric is expressed in bytes-per-second, and is the rate of change of the size of the persistent queue on disk, relative to wall-clock time (queue.queue_size_in_bytes / second). A positive number indicates that the queue size-on-disk is growing, and a negative number indicates that the queue is shrinking.
  
  NOTE: The size of a PQ on disk includes both unacknowledged events and previously-acknowledged events from pages that contain one or more unprocessed events. This means it grows gradually as individual events are added, but shrinks in large chunks each time a whole page of processed events is reclaimed (read more: PQ disk garbage collection).
  
  Hide queue_persisted_growth_bytes attributes Show queue_persisted_growth_bytes attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  queue_persisted_growth_events object
  
  This metric is expressed in events-per-second, and is the rate of change of the number of unacknowledged events in the queue, relative to wall-clock time (queue.events_count / second). A positive number indicates that the queue’s event-count is growing, and a negative number indicates that the queue is shrinking.
  
  Hide queue_persisted_growth_events attributes Show queue_persisted_growth_events attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  plugins object
  
  Hide plugins attributes Show plugins attributes object
  
  inputs array[object]
  
  Hide inputs attributes Show inputs attributes object
  
  id string
  
  name string
  
  flow object
  
  Hide flow attribute Show flow attribute object
  
  throughput object
  
  This metric is expressed in events-per-second, and is the rate of events this input plugin is pushing into the pipeline’s queue relative to wall-clock time (events.in / second). It includes events that are blocked by the queue and have not yet been accepted.
  
  Hide throughput attributes Show throughput attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  events object
  
  Hide events attributes Show events attributes object
  
  out integer(int64)
  
  queue_push_duration_in_millis integer(int64)
  
  codecs array[object]
  
  Hide codecs attributes Show codecs attributes object
  
  id string
  
  name string
  
  decode object
  
  Hide decode attributes Show decode attributes object
  
  duration_in_millis integer
  
  writes_in integer
  
  out integer
  
  encode object
  
  Hide encode attributes Show encode attributes object
  
  duration_in_millis integer
  
  writes_in integer
  
  filters array[object]
  
  Hide filters attributes Show filters attributes object
  
  id string
  
  name string
  
  flow object
  
  Hide flow attributes Show flow attributes object
  
  worker_utilization object
  
  This is a unitless metric that indicates the percentage of available worker time being used by this individual plugin (duration / (uptime * pipeline.workers). It is useful for identifying which plugins in a pipeline are using the available worker resources.
  
  Hide worker_utilization attributes Show worker_utilization attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  worker_millis_per_event object
  
  This metric is expressed in worker-millis-spent-per-event (duration_in_millis / events.in) with higher scores indicating more resources spent per event. It is especially useful for identifying issues with plugins that operate on a small subset of events. An "Infinity" value for a given flow window indicates that worker millis have been spent without any events completing processing; this can indicate a plugin that is either stuck or handling only empty batches.
  
  Hide worker_millis_per_event attributes Show worker_millis_per_event attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  events object
  
  Hide events attributes Show events attributes object
  
  in integer(int64)
  
  out integer(int64)
  
  duration_in_millis integer(int64)
  
  outputs array[object]
  
  Hide outputs attributes Show outputs attributes object
  
  id string
  
  name string
  
  flow object
  
  Hide flow attributes Show flow attributes object
  
  worker_utilization object
  
  This is a unitless metric that indicates the percentage of available worker time being used by this individual plugin (duration / (uptime * pipeline.workers). It is useful for identifying which plugins in a pipeline are using the available worker resources.
  
  Hide worker_utilization attributes Show worker_utilization attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  worker_millis_per_event object
  
  This metric is expressed in worker-millis-spent-per-event (duration_in_millis / events.in) with higher scores indicating more resources spent per event. It is especially useful for identifying issues with plugins that operate on a small subset of events. An "Infinity" value for a given flow window indicates that worker millis have been spent without any events completing processing; this can indicate a plugin that is either stuck or handling only empty batches.
  
  Hide worker_millis_per_event attributes Show worker_millis_per_event attributes object
  
  current number(double) | string
  
  The most recent ~10s.
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_minute number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_5_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_15_minutes number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_1_hour number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  last_24_hours number(double) | string
  
  One of:
  number-1 number(double) string-2 string
  
  lifetime number(double) | string
  
  The lifetime of the relevant pipeline or process.
  
  One of:
  number-1 number(double) string-2 string
  
  events object
  
  Hide events attributes Show events attributes object
  
  in integer(int64)
  
  out integer(int64)
  
  duration_in_millis integer(int64)
  
  reloads object
  
  Hide reloads attributes Show reloads attributes object
  
  last_error string | null
  
  successes integer(int64)
  
  last_success_timestamp string(date-time) | null
  
  last_failure_timestamp string(date-time) | null
  
  failures integer(int64)
  
  queue object
  
  One of:
  object-1 object object-2 object
  
  The metrics of persisted queue.
  
  Hide attributes Show attributes
  
  type string Discriminator
  
  Value is persisted.
  
  capacity object
  
  Hide capacity attributes Show capacity attributes object
  
  max_unread_events integer(int64)
  
  page_capacity_in_bytes integer(int64)
  
  max_queue_size_in_bytes integer(int64)
  
  queue_size_in_bytes integer(int64)
  
  data object
  
  Hide data attributes Show data attributes object
  
  path string
  
  free_space_in_bytes integer(int64)
  
  storage_type string
  
  events integer(int64)
  
  events_count integer(int64)
  
  queue_size_in_bytes integer(int64)
  
  max_queue_size_in_bytes integer(int64)
  
  The metrics of memory queue.
  
  Hide attributes Show attributes
  
  type string Discriminator
  
  Value is memory.
  
  events_count integer(int64)
  
  queue_size_in_bytes integer(int64)
  
  max_queue_size_in_bytes integer(int64)
  
  pipeline object
  
  Hide pipeline attributes Show pipeline attributes object
  
  workers integer
  
  batch_size integer
  
  batch_delay integer
  
  hash string
  
  A unique hash identifier.
  
  ephemeral_id string(uuid)
  
  A temporary unique identifier for the instance.
- reloads object
  
  Hide reloads attributes Show reloads attributes object
  
  successes integer(int64)
  
  failures integer(int64)
- os object
  
  Hide os attributes Show os attributes object
  
  name string
  
  arch string
  
  version string
  
  available_processors integer
- queue object
  
  Hide queue attribute Show queue attribute object
  
  events_count integer(int64)

GET /_node/stats

curl \
 --request GET 'http://api.example.com/_node/stats' \
 --user "username:password"

Response examples (200)

{
  "id": "46e32c2e-b41f-45b7-84c1-1642457f3eba",
  "os": {},
  "jvm": {
    "gc": {
      "collectors": {
        "old": {
          "collection_count": 0,
          "collection_time_in_millis": 0
        },
        "young": {
          "collection_count": 7,
          "collection_time_in_millis": 49
        }
      }
    },
    "mem": {
      "pools": {
        "old": {
          "max_in_bytes": 1073741824,
          "used_in_bytes": 96468992,
          "peak_max_in_bytes": 1073741824,
          "committed_in_bytes": 848297984,
          "peak_used_in_bytes": 96468992
        },
        "young": {
          "max_in_bytes": -1,
          "used_in_bytes": 99614720,
          "peak_max_in_bytes": -1,
          "committed_in_bytes": 199229440,
          "peak_used_in_bytes": 329252864
        },
        "survivor": {
          "max_in_bytes": -1,
          "used_in_bytes": 26214400,
          "peak_max_in_bytes": -1,
          "committed_in_bytes": 26214400,
          "peak_used_in_bytes": 42991616
        }
      },
      "heap_max_in_bytes": 1073741822,
      "heap_used_percent": 20,
      "heap_used_in_bytes": 222298112,
      "non_heap_used_in_bytes": 170675352,
      "heap_committed_in_bytes": 1073741824,
      "non_heap_committed_in_bytes": 176553984
    },
    "threads": {
      "count": 47,
      "peak_count": 47
    },
    "uptime_in_millis": 14712
  },
  "flow": {
    "input_throughput": {
      "current": 0.0776,
      "lifetime": 0.0776
    },
    "filter_throughput": {
      "current": 0.07759,
      "lifetime": 0.07759
    },
    "output_throughput": {
      "current": 0.07759,
      "lifetime": 0.07759
    },
    "queue_backpressure": {
      "current": 0,
      "lifetime": 0
    },
    "worker_concurrency": {
      "current": 0.0004656,
      "lifetime": 0.0004656
    }
  },
  "host": "Mac",
  "name": "Mac",
  "queue": {
    "events_count": 0
  },
  "events": {
    "in": 1,
    "out": 1,
    "filtered": 1,
    "duration_in_millis": 6,
    "queue_push_duration_in_millis": 0
  },
  "status": "green",
  "process": {
    "cpu": {
      "percent": 0,
      "load_average": {
        "1m": 4.07177734375
      },
      "total_in_millis": 20823
    },
    "mem": {
      "total_virtual_in_bytes": 425113862144
    },
    "max_file_descriptors": 10240,
    "open_file_descriptors": 87,
    "peak_open_file_descriptors": 87
  },
  "reloads": {
    "failures": 0,
    "successes": 0
  },
  "version": "9.1.0",
  "pipeline": {
    "workers": 12,
    "batch_size": 125,
    "batch_delay": 50
  },
  "snapshot": null,
  "pipelines": {
    "heartbeat-ruby-stdout": {
      "flow": {
        "input_throughput": {
          "current": 0.07962,
          "lifetime": 0.07962
        },
        "filter_throughput": {
          "current": 0.07963,
          "lifetime": 0.07963
        },
        "output_throughput": {
          "current": 0.07963,
          "lifetime": 0.07963
        },
        "queue_backpressure": {
          "current": 0,
          "lifetime": 0
        },
        "worker_concurrency": {
          "current": 0.0004779,
          "lifetime": 0.0004779
        },
        "worker_utilization": {
          "current": 0.003982,
          "lifetime": 0.003982
        }
      },
      "hash": "c11e0502ebf98956dffa371775fd1cb719f85f819ee166b770b3e982da1c999d",
      "queue": {
        "type": "memory",
        "events_count": 0,
        "queue_size_in_bytes": 0,
        "max_queue_size_in_bytes": 0
      },
      "events": {
        "in": 1,
        "out": 1,
        "filtered": 1,
        "duration_in_millis": 6,
        "queue_push_duration_in_millis": 0
      },
      "plugins": {
        "codecs": [
          {
            "id": "be3a3aba-ee75-4978-af58-d22b856d0e35",
            "name": "rubydebug"
          },
          {
            "id": "plain_22e7b41b-756a-4b52-b03c-a30b31bb6266",
            "name": "plain",
            "decode": {
              "out": 0,
              "writes_in": 0,
              "duration_in_millis": 0
            },
            "encode": {
              "writes_in": 0,
              "duration_in_millis": 0
            }
          }
        ],
        "inputs": [
          {
            "id": "c9ca46e359d73146590ca8af40092342afa922f3cbf07adc4b5009e346cb19f7",
            "flow": {
              "throughput": {
                "current": 0.07963,
                "lifetime": 0.07963
              }
            },
            "name": "heartbeat",
            "events": {
              "out": 1,
              "queue_push_duration_in_millis": 0
            }
          }
        ],
        "filters": [
          {
            "id": "585fa932a4fd506055ead07ee5ebcb3033c27c82ba90cbee73d6ac7e9357333a",
            "flow": {
              "worker_utilization": {
                "current": 0.0006636,
                "lifetime": 0.0006636
              },
              "worker_millis_per_event": {
                "current": 1,
                "lifetime": 1
              }
            },
            "name": "ruby",
            "events": {
              "in": 1,
              "out": 1,
              "duration_in_millis": 1
            }
          }
        ],
        "outputs": [
          {
            "id": "c4f801c8f170b4cb0679f704413773acd5f291929f42302d0a56361400c3741b",
            "flow": {
              "worker_utilization": {
                "current": 0.001991,
                "lifetime": 0.001991
              },
              "worker_millis_per_event": {
                "current": 3,
                "lifetime": 3
              }
            },
            "name": "stdout",
            "events": {
              "in": 1,
              "out": 1,
              "duration_in_millis": 3
            }
          }
        ]
      },
      "reloads": {
        "failures": 0,
        "successes": 0,
        "last_error": null,
        "last_failure_timestamp": null,
        "last_success_timestamp": null
      },
      "pipeline": {
        "workers": 12,
        "batch_size": 125,
        "batch_delay": 50
      },
      "ephemeral_id": "cd90b521-c192-437e-a49e-62fabebde7e2"
    }
  },
  "ephemeral_id": "1752e2fe-7710-44d0-a2f8-a3005b6273c8",
  "http_address": "127.0.0.1:9600"
}

Get config reload statistics

GET /_node/stats/reloads

Basic auth

Get information about config reload successes and failures.

Query parameters

pretty boolean

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

Responses

200 application/json

A JSON object containing process statistics.
Hide response attribute Show response attribute object
- reloads object
  
  Hide reloads attributes Show reloads attributes object
  
  successes integer(int64)
  
  failures integer(int64)

GET /_node/stats/reloads

curl \
 --request GET 'http://api.example.com/_node/stats/reloads' \
 --user "username:password"

Response examples (200)

{
  "reloads": {
    "failures": 0,
    "successes": 0
  }
}

current number(double) | string

last_1_minute number(double) | string

last_5_minutes number(double) | string

last_15_minutes number(double) | string

last_1_hour number(double) | string

last_24_hours number(double) | string

lifetime number(double) | string

current number(double) | string

last_1_minute number(double) | string

last_5_minutes number(double) | string

last_15_minutes number(double) | string

last_1_hour number(double) | string

last_24_hours number(double) | string

lifetime number(double) | string

current number(double) | string

last_1_minute number(double) | string

last_5_minutes number(double) | string

last_15_minutes number(double) | string

last_1_hour number(double) | string

last_24_hours number(double) | string

lifetime number(double) | string

current number(double) | string

last_1_minute number(double) | string

last_5_minutes number(double) | string

last_15_minutes number(double) | string

last_1_hour number(double) | string

last_24_hours number(double) | string

lifetime number(double) | string

current number(double) | string

last_1_minute number(double) | string

last_5_minutes number(double) | string

last_15_minutes number(double) | string

last_1_hour number(double) | string

last_24_hours number(double) | string

lifetime number(double) | string

flow object

current number(double) | string

last_1_minute number(double) | string

last_5_minutes number(double) | string

last_15_minutes number(double) | string

last_1_hour number(double) | string

last_24_hours number(double) | string

lifetime number(double) | string

current number(double) | string

last_1_minute number(double) | string

last_5_minutes number(double) | string

last_15_minutes number(double) | string

last_1_hour number(double) | string

last_24_hours number(double) | string

lifetime number(double) | string

current number(double) | string

last_1_minute number(double) | string

last_5_minutes number(double) | string

last_15_minutes number(double) | string

last_1_hour number(double) | string

last_24_hours number(double) | string

lifetime number(double) | string

current number(double) | string

last_1_minute number(double) | string

last_5_minutes number(double) | string

last_15_minutes number(double) | string

last_1_hour number(double) | string

last_24_hours number(double) | string

lifetime number(double) | string

current number(double) | string

last_1_minute number(double) | string

last_5_minutes number(double) | string

last_15_minutes number(double) | string

last_1_hour number(double) | string

last_24_hours number(double) | string

lifetime number(double) | string

current number(double) | string

last_1_minute number(double) | string

last_5_minutes number(double) | string

last_15_minutes number(double) | string

last_1_hour number(double) | string

last_24_hours number(double) | string

lifetime number(double) | string

current number(double) | string

last_1_minute number(double) | string