Path parameters

• target string | array[string]

  Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest.

  Supported values include: _all, http, ingest, thread_pool, script

  Values are _all, http, ingest, thread_pool, or script.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • cluster_name string Required
  • http object
    Hide http attributes Show http attributes object

    • current_open number

      Current number of open HTTP connections for the node.

    • total_opened number

      Total number of HTTP connections opened for the node.

    • clients array[object]

      Information on current and recently-closed HTTP client connections. Clients that have been closed longer than the http.client_stats.closed_channels.max_age setting will not be represented here.

      Hide clients attributes Show clients attributes object

      • id number

        Unique ID for the HTTP client.

      • agent string

        Reported agent for the HTTP client. If unavailable, this property is not included in the response.

      • local_address string

        Local address for the HTTP connection.

      • remote_address string

        Remote address for the HTTP connection.

      • last_uri string

        The URI of the client’s most recent request.

      • opened_time_millis number

        Time at which the client opened the connection.

      • closed_time_millis number

        Time at which the client closed the connection if the connection is closed.

      • last_request_time_millis number

        Time of the most recent request from this client.

      • request_count number

        Number of requests from this client.

      • request_size_bytes number

        Cumulative size in bytes of all requests from this client.

      • x_opaque_id string

        Value from the client’s x-opaque-id HTTP header. If unavailable, this property is not included in the response.

    • routes object Required Generally available; Added in 8.12.0

      Detailed HTTP stats broken down by route

      Hide routes attribute Show routes attribute object

      • * object Additional properties
        Hide * attributes Show * attributes object

        • requests object Required
          Hide requests attributes Show requests attributes object

          • count number Required
          • total_size_in_bytes number Required
          • size_histogram array[object] Required
        • responses object Required
          Hide responses attributes Show responses attributes object

          • count number Required
          • total_size_in_bytes number Required
          • handling_time_histogram array[object] Required
          • size_histogram array[object] Required
  • ingest object
    Hide ingest attributes Show ingest attributes object

    • pipelines object

      Contains statistics about ingest pipelines for the node.

      Hide pipelines attribute Show pipelines attribute object

      • * object Additional properties
        Hide * attributes Show * attributes object

        • count number Required

          Total number of documents ingested during the lifetime of this node.

        • current number Required

          Total number of documents currently being ingested.

        • failed number Required

          Total number of failed ingest operations during the lifetime of this node.

        • processors array[object] Required

          Total number of ingest processors.

          Hide processors attribute Show processors attribute object

          • * object Additional properties
        • time_in_millis number

          Time unit for milliseconds

        • ingested_as_first_pipeline_in_bytes number Required Generally available; Added in 8.15.0

          Total number of bytes of all documents ingested by the pipeline. This field is only present on pipelines which are the first to process a document. Thus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.

        • produced_as_first_pipeline_in_bytes number Required Generally available; Added in 8.15.0

          Total number of bytes of all documents produced by the pipeline. This field is only present on pipelines which are the first to process a document. Thus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors. In situations where there are subsequent pipelines, the value represents the size of the document after all pipelines have run.

    • total object
      Hide total attributes Show total attributes object

      • count number Required

        Total number of documents ingested during the lifetime of this node.

      • current number Required

        Total number of documents currently being ingested.

      • failed number Required

        Total number of failed ingest operations during the lifetime of this node.

      • time_in_millis number

        Time unit for milliseconds

  • thread_pool object
    Hide thread_pool attribute Show thread_pool attribute object

    • * object Additional properties
      Hide * attributes Show * attributes object

      • active number

        Number of active threads in the thread pool.

      • completed number

        Number of tasks completed by the thread pool executor.

      • largest number

        Highest number of active threads in the thread pool.

      • queue number

        Number of tasks in queue for the thread pool.

      • rejected number

        Number of tasks rejected by the thread pool executor.

      • threads number

        Number of threads in the thread pool.

  • script object
    Hide script attributes Show script attributes object

    • cache_evictions number

      Total number of times the script cache has evicted old data.

    • compilations number

      Total number of inline script compilations performed by the node.

    • compilations_history object

      Contains this recent history of script compilations.

      Hide compilations_history attribute Show compilations_history attribute object

      • * number Additional properties
    • compilation_limit_triggered number

      Total number of times the script compilation circuit breaker has limited inline script compilations.

    • contexts array[object]
      Hide contexts attributes Show contexts attributes object

      • context string
      • compilations number
      • cache_evictions number
      • compilation_limit_triggered number