Get node statistics

GET /_node/stats

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
    • 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

        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:
        • plugins object
          Hide plugins attributes Show plugins attributes object
        • reloads object
          Hide reloads attributes Show reloads attributes object
          • last_error string | null
          • successes integer(int64)
          • last_success_timestamp string | null
          • last_failure_timestamp string | null
          • failures integer(int64)
        • queue object

          One of:
        • 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" }