Get cluster subsystem info

Auth

Returns basic information about the cluster.

Path parameters

target union enum | enum[] required

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: _all http ingest thread_pool script

Response

application/json
cluster_name string required
http 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 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.

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 string

Time at which the client opened the connection.

opened_time_millis number

Time at which the client opened the connection.

closed_time string

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

closed_time_millis number

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

last_request_time string

Time of the most recent request from this client.

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 map string to object required

Detailed HTTP stats broken down by route

<string> object
requests object required
count number required
total_size number | string
total_size_in_bytes number required
size_histogram object[] required
count number required
ge number | string
ge_bytes number
lt number | string
lt_bytes number
responses object required
count number required
total_size number | string
total_size_in_bytes number required
handling_time_histogram object[] required
count number required
ge string
ge_millis number
lt string
lt_millis number
size_histogram object[] required
count number required
ge number | string
ge_bytes number
lt number | string
lt_bytes number
ingest object
pipelines map string to object

Contains statistics about ingest pipelines for the node.

<string> 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 string to object[] required

Total number of ingest processors.

time string

Total time spent preprocessing ingest documents during the lifetime of this node.

time_in_millis number required

Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.

ingested_as_first_pipeline number | string

Total size of all documents ingested by the pipeline. The value counts documents for which this pipeline was the first to process them; for pipelines that are not the first to process a document (for example, a final pipeline after a default pipeline, a pipeline run after a reroute processor, or a pipeline invoked by a pipeline processor), the value is 0.

ingested_as_first_pipeline_in_bytes number required

Total number of bytes of all documents ingested by the pipeline. The value counts documents for which this pipeline was the first to process them; for pipelines that are not the first to process a document, the value is 0.

produced_as_first_pipeline number | string

Total size of all documents produced by the pipeline. The value counts documents for which this pipeline was the first to process them; for pipelines that are not the first to process a document, the value is 0. In situations where there are subsequent pipelines, the value represents the size of the document after all pipelines have run.

produced_as_first_pipeline_in_bytes number required

Total number of bytes of all documents produced by the pipeline. The value counts documents for which this pipeline was the first to process them; for pipelines that are not the first to process a document, the value is 0. In situations where there are subsequent pipelines, the value represents the size of the document after all pipelines have run.

total object

Contains statistics about ingest operations for the node.

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 string

Total time spent preprocessing ingest documents during the lifetime of this node.

time_in_millis number required

Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.

thread_pool map string to object
<string> 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
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 map string to number

Contains this recent history of script compilations.

compilation_limit_triggered number

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

contexts object[]
context string
compilations number
cache_evictions number
compilation_limit_triggered number