123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367 |
- [[cluster-nodes-stats]]
- === Nodes stats API
- ++++
- <titleabbrev>Nodes stats</titleabbrev>
- ++++
- Returns cluster nodes statistics.
- [[cluster-nodes-stats-api-request]]
- ==== {api-request-title}
- `GET /_nodes/stats` +
- `GET /_nodes/<node_id>/stats` +
- `GET /_nodes/stats/<metric>` +
- `GET /_nodes/<node_id>/stats/<metric>` +
- `GET /_nodes/stats/<metric>/<index_metric>` +
- `GET /_nodes/<node_id>/stats/<metric>/<index_metric>`
- [[cluster-nodes-stats-api-prereqs]]
- ==== {api-prereq-title}
- * If the {es} {security-features} are enabled, you must have the `monitor` or
- `manage` <<privileges-list-cluster,cluster privilege>> to use this API.
- [[cluster-nodes-stats-api-desc]]
- ==== {api-description-title}
- You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster.
- All the nodes selective options are explained <<cluster-nodes,here>>.
- By default, all stats are returned. You can limit the returned information by
- using metrics.
- [[cluster-nodes-stats-api-path-params]]
- ==== {api-path-parms-title}
- `<metric>`::
- (Optional, string) Limits the information returned to the specific metrics.
- A comma-separated list of the following options:
- +
- --
- `adaptive_selection`::
- Statistics about <<search-adaptive-replica,adaptive replica selection>>.
- `breaker`::
- Statistics about the field data circuit breaker.
- `discovery`::
- Statistics about the discovery.
- `fs`::
- File system information, data path, free disk space, read/write
- stats.
- `http`::
- HTTP connection information.
- `indexing_pressure`::
- Statistics about the node's indexing load and related rejections.
- `indices`::
- Indices stats about size, document count, indexing and deletion times,
- search times, field cache size, merges and flushes.
- `ingest`::
- Statistics about ingest preprocessing.
- `jvm`::
- JVM stats, memory pool information, garbage collection, buffer
- pools, number of loaded/unloaded classes.
- `os`::
- Operating system stats, load average, mem, swap.
- `process`::
- Process statistics, memory consumption, cpu usage, open
- file descriptors.
- `thread_pool`::
- Statistics about each thread pool, including current size, queue and
- rejected tasks.
- `transport`::
- Transport statistics about sent and received bytes in cluster
- communication.
- --
- `<index_metric>`::
- (Optional, string) Limit the information returned for `indices` metric to
- the specific index metrics. It can be used only if `indices` (or `all`)
- metric is specified. Supported metrics are:
- +
- --
- * `completion`
- * `docs`
- * `fielddata`
- * `flush`
- * `get`
- * `indexing`
- * `merge`
- * `query_cache`
- * `recovery`
- * `refresh`
- * `request_cache`
- * `search`
- * `segments`
- * `store`
- * `translog`
- * `warmer`
- --
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
- [[cluster-nodes-stats-api-query-params]]
- ==== {api-query-parms-title}
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=completion-fields]
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields]
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields]
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=groups]
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=level]
- `types`::
- (Optional, string) A comma-separated list of document types for the
- `indexing` index metric.
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes]
- [role="child_attributes"]
- [[cluster-nodes-stats-api-response-body]]
- ==== {api-response-body-title}
- `_nodes`::
- (object)
- Contains statistics about the number of nodes selected by the request.
- +
- .Properties of `_nodes`
- [%collapsible%open]
- ====
- `total`::
- (integer)
- Total number of nodes selected by the request.
- `successful`::
- (integer)
- Number of nodes that responded successfully to the request.
- `failed`::
- (integer)
- Number of nodes that rejected the request or failed to respond. If this value
- is not `0`, a reason for the rejection or failure is included in the response.
- ====
- `cluster_name`::
- (string)
- Name of the cluster. Based on the <<cluster-name>> setting.
- `nodes`::
- (object)
- Contains statistics for the nodes selected by the request.
- +
- .Properties of `nodes`
- [%collapsible%open]
- ====
- `<node_id>`::
- (object)
- Contains statistics for the node.
- +
- .Properties of `<node_id>`
- [%collapsible%open]
- =====
- `timestamp`::
- (integer)
- Time the node stats were collected for this response. Recorded in milliseconds
- since the {wikipedia}/Unix_time[Unix Epoch].
- `name`::
- (string)
- Human-readable identifier for the node. Based on the <<node-name>> setting.
- `transport_address`::
- (string)
- Host and port for the <<modules-transport,transport layer>>, used for internal
- communication between nodes in a cluster.
- `host`::
- (string)
- Network host for the node, based on the <<network.host>> setting.
- `ip`::
- (string)
- IP address and port for the node.
- `roles`::
- (array of strings)
- Roles assigned to the node. See <<modules-node>>.
- `attributes`::
- (object)
- Contains a list of attributes for the node.
- [[cluster-nodes-stats-api-response-body-indices]]
- `indices`::
- (object)
- Contains statistics about indices with shards assigned to the node.
- +
- .Properties of `indices`
- [%collapsible%open]
- ======
- `docs`::
- (object)
- Contains statistics about documents across all primary shards assigned to the
- node.
- +
- .Properties of `docs`
- [%collapsible%open]
- =======
- `count`::
- (integer)
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-count]
- `deleted`::
- (integer)
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted]
- =======
- `store`::
- (object)
- Contains statistics about the size of shards assigned to the node.
- +
- .Properties of `store`
- [%collapsible%open]
- =======
- `size`::
- (<<byte-units,byte value>>)
- Total size of all shards assigned to the node.
- `size_in_bytes`::
- (integer)
- Total size, in bytes, of all shards assigned to the node.
- `reserved`::
- (<<byte-units,byte value>>)
- A prediction of how much larger the shard stores on this node will eventually
- grow due to ongoing peer recoveries, restoring snapshots, and similar
- activities. A value of `-1b` indicates that this is not available.
- `reserved_in_bytes`::
- (integer)
- A prediction, in bytes, of how much larger the shard stores on this node will
- eventually grow due to ongoing peer recoveries, restoring snapshots, and
- similar activities. A value of `-1` indicates that this is not available.
- =======
- `indexing`::
- (object)
- Contains statistics about indexing operations for the node.
- +
- .Properties of `indexing`
- [%collapsible%open]
- =======
- `index_total`::
- (integer)
- Total number of indexing operations.
- `index_time`::
- (<<time-units,time value>>)
- Total time spent performing indexing operations.
- `index_time_in_millis`::
- (integer)
- Total time in milliseconds
- spent performing indexing operations.
- `index_current`::
- (integer)
- Number of indexing operations currently running.
- `index_failed`::
- (integer)
- Number of failed indexing operations.
- `delete_total`::
- (integer)
- Total number of deletion operations.
- `delete_time`::
- (<<time-units,time value>>)
- Time spent performing deletion operations.
- `delete_time_in_millis`::
- (integer)
- Time in milliseconds
- spent performing deletion operations.
- `delete_current`::
- (integer)
- Number of deletion operations currently running.
- `noop_update_total`::
- (integer)
- Total number of noop operations.
- `is_throttled`::
- (Boolean)
- Number of times
- operations were throttled.
- `throttle_time`::
- (<<time-units,time value>>)
- Total time spent throttling operations.
- `throttle_time_in_millis`::
- (integer)
- Total time in milliseconds
- spent throttling operations.
- =======
- `get`::
- (object)
- Contains statistics about get operations for the node.
- +
- .Properties of `get`
- [%collapsible%open]
- =======
- `total`::
- (integer)
- Total number of get operations.
- `getTime`::
- (<<time-units,time value>>)
- Time spent performing get operations.
- `time_in_millis`::
- (integer)
- Time in milliseconds
- spent performing get operations.
- `exists_total`::
- (integer)
- Total number of successful get operations.
- `exists_time`::
- (<<time-units,time value>>)
- Time spent performing successful get operations.
- `exists_time_in_millis`::
- (integer)
- Time in milliseconds
- spent performing successful get operations.
- `missing_total`::
- (integer)
- Total number of failed get operations.
- `missing_time`::
- (<<time-units,time value>>)
- Time spent performing failed get operations.
- `missing_time_in_millis`::
- (integer)
- Time in milliseconds
- spent performing failed get operations.
- `current`::
- (integer)
- Number of get operations currently running.
- =======
- `search`::
- (object)
- Contains statistics about search operations for the node.
- +
- .Properties of `search`
- [%collapsible%open]
- =======
- `open_contexts`::
- (integer)
- Number of open search contexts.
- `query_total`::
- (integer)
- Total number of query operations.
- `query_time`::
- (<<time-units,time value>>)
- Time spent performing query operations.
- `query_time_in_millis`::
- (integer)
- Time in milliseconds
- spent performing query operations.
- `query_current`::
- (integer)
- Number of query operations currently running.
- `fetch_total`::
- (integer)
- Total number of fetch operations.
- `fetch_time`::
- (<<time-units,time value>>)
- Time spent performing fetch operations.
- `fetch_time_in_millis`::
- (integer)
- Time in milliseconds
- spent performing fetch operations.
- `fetch_current`::
- (integer)
- Number of fetch operations currently running.
- `scroll_total`::
- (integer)
- Total number of scroll operations.
- `scroll_time`::
- (<<time-units,time value>>)
- Time spent performing scroll operations.
- `scroll_time_in_millis`::
- (integer)
- Time in milliseconds
- spent performing scroll operations.
- `scroll_current`::
- (integer)
- Number of scroll operations currently running.
- `suggest_total`::
- (integer)
- Total number of suggest operations.
- `suggest_time`::
- (<<time-units,time value>>)
- Time spent performing suggest operations.
- `suggest_time_in_millis`::
- (integer)
- Time in milliseconds
- spent performing suggest operations.
- `suggest_current`::
- (integer)
- Number of suggest operations currently running.
- =======
- `merges`::
- (object)
- Contains statistics about merge operations for the node.
- +
- .Properties of `merges`
- [%collapsible%open]
- =======
- `current`::
- (integer)
- Number of merge operations currently running.
- `current_docs`::
- (integer)
- Number of document merges currently running.
- `current_size`::
- (<<byte-units,byte value>>)
- Memory used performing current document merges.
- `current_size_in_bytes`::
- (integer)
- Memory, in bytes, used performing current document merges.
- `total`::
- (integer)
- Total number of merge operations.
- `total_time`::
- (<<time-units,time value>>)
- Total time spent performing merge operations.
- `total_time_in_millis`::
- (integer)
- Total time in milliseconds
- spent performing merge operations.
- `total_docs`::
- (integer)
- Total number of merged documents.
- `total_size`::
- (<<byte-units,byte value>>)
- Total size of document merges.
- `total_size_in_bytes`::
- (integer)
- Total size of document merges in bytes.
- `total_stopped_time`::
- (<<time-units,time value>>)
- Total time spent stopping merge operations.
- `total_stopped_time_in_millis`::
- (integer)
- Total time in milliseconds
- spent stopping merge operations.
- `total_throttled_time`::
- (<<time-units,time value>>)
- Total time spent throttling merge operations.
- `total_throttled_time_in_millis`::
- (integer)
- Total time in milliseconds
- spent throttling merge operations.
- `total_auto_throttle`::
- (<<byte-units,byte value>>)
- Size of automatically throttled merge operations.
- `total_auto_throttle_in_bytes`::
- (integer)
- Size, in bytes, of automatically throttled merge operations.
- =======
- `refresh`::
- (object)
- Contains statistics about refresh operations for the node.
- +
- .Properties of `refresh`
- [%collapsible%open]
- =======
- `total`::
- (integer)
- Total number of refresh operations.
- `total_time`::
- (<<time-units,time value>>)
- Total time spent performing refresh operations.
- `total_time_in_millis`::
- (integer)
- Total time in milliseconds
- spent performing refresh operations.
- `external_total`::
- (integer)
- Total number of external refresh operations.
- `external_total_time`::
- (<<time-units,time value>>)
- Total time spent performing external operations.
- `external_total_time_in_millis`::
- (integer)
- Total time in milliseconds
- spent performing external operations.
- `listeners`::
- (integer)
- Number of refresh listeners.
- =======
- `flush`::
- (object)
- Contains statistics about flush operations for the node.
- +
- .Properties of `flush`
- [%collapsible%open]
- =======
- `total`::
- (integer)
- Number of flush operations.
- `periodic`::
- (integer)
- Number of flush periodic operations.
- `total_time`::
- (<<time-units,time value>>)
- Total time spent performing flush operations.
- `total_time_in_millis`::
- (integer)
- Total time in milliseconds
- spent performing flush operations.
- =======
- `warmer`::
- (object)
- Contains statistics about index warming operations for the node.
- +
- .Properties of `warmer`
- [%collapsible%open]
- =======
- `current`::
- (integer)
- Number of active index warmers.
- `total`::
- (integer)
- Total number of index warmers.
- `total_time`::
- (<<time-units,time value>>)
- Total time spent performing index warming operations.
- `total_time_in_millis`::
- (integer)
- Total time in milliseconds
- spent performing index warming operations.
- =======
- `query_cache`::
- (object)
- Contains statistics about the query cache across all shards assigned to the
- node.
- +
- .Properties of `query_cache`
- [%collapsible%open]
- =======
- `memory_size`::
- (<<byte-units,byte value>>)
- Total amount of memory used for the query cache across all shards assigned to
- the node.
- `memory_size_in_bytes`::
- (integer)
- Total amount of memory, in bytes, used for the query cache across all shards
- assigned to the node.
- `total_count`::
- (integer)
- Total count of hits, misses, and cached queries
- in the query cache.
- `hit_count`::
- (integer)
- Number of query cache hits.
- `miss_count`::
- (integer)
- Number of query cache misses.
- `cache_size`::
- (integer)
- Size, in bytes, of the query cache.
- `cache_count`::
- (integer)
- Count of queries
- in the query cache.
- `evictions`::
- (integer)
- Number of query cache evictions.
- =======
- `fielddata`::
- (object)
- Contains statistics about the field data cache across all shards
- assigned to the node.
- +
- .Properties of `fielddata`
- [%collapsible%open]
- =======
- `memory_size`::
- (<<byte-units,byte value>>)
- Total amount of memory used for the field data cache across all shards
- assigned to the node.
- `memory_size_in_bytes`::
- (integer)
- Total amount of memory, in bytes, used for the field data cache across all
- shards assigned to the node.
- `evictions`::
- (integer)
- Number of fielddata evictions.
- =======
- `completion`::
- (object)
- Contains statistics about completions across all shards assigned to the node.
- +
- .Properties of `completion`
- [%collapsible%open]
- =======
- `size`::
- (<<byte-units,byte value>>)
- Total amount of memory used for completion across all shards assigned to
- the node.
- `size_in_bytes`::
- (integer)
- Total amount of memory, in bytes, used for completion across all shards assigned
- to the node.
- =======
- `segments`::
- (object)
- Contains statistics about segments across all shards assigned to the node.
- +
- .Properties of `segments`
- [%collapsible%open]
- =======
- `count`::
- (integer)
- Number of segments.
- `memory`::
- (<<byte-units,byte value>>)
- Total amount of memory used for segments across all shards assigned to the
- node.
- `memory_in_bytes`::
- (integer)
- Total amount of memory, in bytes, used for segments across all shards assigned
- to the node.
- `terms_memory`::
- (<<byte-units,byte value>>)
- Total amount of memory used for terms across all shards assigned to the node.
- `terms_memory_in_bytes`::
- (integer)
- Total amount of memory, in bytes, used for terms across all shards assigned to
- the node.
- `stored_fields_memory`::
- (<<byte-units,byte value>>)
- Total amount of memory used for stored fields across all shards assigned to
- the node.
- `stored_fields_memory_in_bytes`::
- (integer)
- Total amount of memory, in bytes, used for stored fields across all shards
- assigned to the node.
- `term_vectors_memory`::
- (<<byte-units,byte value>>)
- Total amount of memory used for term vectors across all shards assigned to
- the node.
- `term_vectors_memory_in_bytes`::
- (integer)
- Total amount of memory, in bytes, used for term vectors across all shards
- assigned to the node.
- `norms_memory`::
- (<<byte-units,byte value>>)
- Total amount of memory used for normalization factors across all shards assigned
- to the node.
- `norms_memory_in_bytes`::
- (integer)
- Total amount of memory, in bytes, used for normalization factors across all
- shards assigned to the node.
- `points_memory`::
- (<<byte-units,byte value>>)
- Total amount of memory used for points across all shards assigned to the node.
- `points_memory_in_bytes`::
- (integer)
- Total amount of memory, in bytes, used for points across all shards assigned to
- the node.
- `doc_values_memory`::
- (<<byte-units,byte value>>)
- Total amount of memory used for doc values across all shards assigned to
- the node.
- `doc_values_memory_in_bytes`::
- (integer)
- Total amount of memory, in bytes, used for doc values across all shards assigned
- to the node.
- `index_writer_memory`::
- (<<byte-units,byte value>>)
- Total amount of memory used by all index writers across all shards assigned to
- the node.
- `index_writer_memory_in_bytes`::
- (integer)
- Total amount of memory, in bytes, used by all index writers across all shards
- assigned to the node.
- `version_map_memory`::
- (<<byte-units,byte value>>)
- Total amount of memory used by all version maps across all shards assigned to
- the node.
- `version_map_memory_in_bytes`::
- (integer)
- Total amount of memory, in bytes, used by all version maps across all shards
- assigned to the node.
- `fixed_bit_set`::
- (<<byte-units,byte value>>)
- Total amount of memory used by fixed bit sets across all shards assigned to
- the node.
- +
- Fixed bit sets are used for nested object field types and
- type filters for <<parent-join,join>> fields.
- `fixed_bit_set_memory_in_bytes`::
- (integer)
- Total amount of memory, in bytes, used by fixed bit sets across all shards
- assigned to the node.
- +
- Fixed bit sets are used for nested object field types and
- type filters for <<parent-join,join>> fields.
- `max_unsafe_auto_id_timestamp`::
- (integer)
- Time of the most recently retried indexing request. Recorded in milliseconds
- since the {wikipedia}/Unix_time[Unix Epoch].
- `file_sizes`::
- (object)
- Contains statistics about the size of the segment file.
- +
- .Properties of `file_sizes`
- [%collapsible%open]
- ========
- `size`::
- (<<byte-units,byte value>>)
- Size of the segment file.
- `size_in_bytes`::
- (integer)
- Size, in bytes,
- of the segment file.
- `description`::
- (string)
- Description of the segment file.
- ========
- =======
- `translog`::
- (object)
- Contains statistics about transaction log operations for the node.
- +
- .Properties of `translog`
- [%collapsible%open]
- =======
- `operations`::
- (integer)
- Number of transaction log operations.
- `size`::
- (<<byte-units,byte value>>)
- Size of the transaction log.
- `size_in_bytes`::
- (integer)
- Size, in bytes, of the transaction log.
- `uncommitted_operations`::
- (integer)
- Number of uncommitted transaction log operations.
- `uncommitted_size`::
- (<<byte-units,byte value>>)
- Size of uncommitted transaction log operations.
- `uncommitted_size_in_bytes`::
- (integer)
- Size, in bytes, of uncommitted transaction log operations.
- `earliest_last_modified_age`::
- (integer)
- Earliest last modified age
- for the transaction log.
- =======
- `request_cache`::
- (object)
- Contains statistics about the request cache across all shards assigned to the
- node.
- +
- .Properties of `request_cache`
- [%collapsible%open]
- =======
- `memory_size`::
- (<<byte-units,byte value>>)
- Memory used by the request cache.
- `memory_size_in_bytes`::
- (integer)
- Memory, in bytes, used by the request cache.
- `evictions`::
- (integer)
- Number of request cache operations.
- `hit_count`::
- (integer)
- Number of request cache hits.
- `miss_count`::
- (integer)
- Number of request cache misses.
- =======
- `recovery`::
- (object)
- Contains statistics about recovery operations for the node.
- +
- .Properties of `recovery`
- [%collapsible%open]
- =======
- `current_as_source`::
- (integer)
- Number of recoveries
- that used an index shard as a source.
- `current_as_target`::
- (integer)
- Number of recoveries
- that used an index shard as a target.
- `throttle_time`::
- (<<time-units,time value>>)
- Time by which recovery operations were delayed due to throttling.
- `throttle_time_in_millis`::
- (integer)
- Time in milliseconds
- recovery operations were delayed due to throttling.
- =======
- ======
- [[cluster-nodes-stats-api-response-body-os]]
- `os`::
- (object)
- Contains statistics about the operating system for the node.
- +
- .Properties of `os`
- [%collapsible%open]
- ======
- `timestamp`::
- (integer)
- Last time the operating system statistics were refreshed. Recorded in
- milliseconds since the {wikipedia}/Unix_time[Unix Epoch].
- `cpu`::
- (object)
- Contains statistics about CPU usage for the node.
- +
- .Properties of `cpu`
- [%collapsible%open]
- =======
- `percent`::
- (integer)
- Recent CPU usage for the whole system, or `-1` if not supported.
- `load_average`::
- (object)
- Contains statistics about load averages on the system.
- +
- .Properties of `load_average`
- [%collapsible%open]
- ========
- `1m`::
- (float)
- One-minute load average on the system (field is not present if one-minute load
- average is not available).
- `5m`::
- (float)
- Five-minute load average on the system (field is not present if five-minute load
- average is not available).
- `15m`::
- (float)
- Fifteen-minute load average on the system (field is not present if
- fifteen-minute load average is not available).
- ========
- =======
- `mem`::
- (object)
- Contains statistics about memory usage for the node.
- +
- .Properties of `mem`
- [%collapsible%open]
- =======
- `total`::
- (<<byte-units,byte value>>)
- Total amount of physical memory.
- `total_in_bytes`::
- (integer)
- Total amount of physical memory in bytes.
- `free`::
- (<<byte-units,byte value>>)
- Amount of free physical memory.
- `free_in_bytes`::
- (integer)
- Amount of free physical memory in bytes.
- `used`::
- (<<byte-units,byte value>>)
- Amount of used physical memory.
- `used_in_bytes`::
- (integer)
- Amount of used physical memory in bytes.
- `free_percent`::
- (integer)
- Percentage of free memory.
- `used_percent`::
- (integer)
- Percentage of used memory.
- =======
- `swap`::
- (object)
- Contains statistics about swap space for the node.
- +
- .Properties of `swap`
- [%collapsible%open]
- =======
- `total`::
- (<<byte-units,byte value>>)
- Total amount of swap space.
- `total_in_bytes`::
- (integer)
- Total amount of swap space in bytes.
- `free`::
- (<<byte-units,byte value>>)
- Amount of free swap space.
- `free_in_bytes`::
- (integer)
- Amount of free swap space in bytes.
- `used`::
- (<<byte-units,byte value>>)
- Amount of used swap space.
- `used_in_bytes`::
- (integer)
- Amount of used swap space in bytes.
- =======
- `cgroup` (Linux only)::
- (object)
- Contains cgroup statistics for the node.
- +
- NOTE: For the cgroup stats to be visible, cgroups must be compiled into the
- kernel, the `cpu` and `cpuacct` cgroup subsystems must be configured and stats
- must be readable from `/sys/fs/cgroup/cpu` and `/sys/fs/cgroup/cpuacct`.
- +
- .Properties of `cgroup`
- [%collapsible%open]
- =======
- `cpuacct` (Linux only)::
- (object)
- Contains statistics about `cpuacct` control group for the node.
- +
- .Properties of `cpuacct`
- [%collapsible%open]
- ========
- `control_group` (Linux only)::
- (string)
- The `cpuacct` control group to which the {es} process belongs.
- `usage_nanos` (Linux only)::
- (integer)
- The total CPU time (in nanoseconds) consumed by all tasks in the same cgroup
- as the {es} process.
- ========
- `cpu` (Linux only)::
- (object)
- Contains statistics about `cpu` control group for the node.
- +
- .Properties of `cpu`
- [%collapsible%open]
- ========
- `control_group` (Linux only)::
- (string)
- The `cpu` control group to which the {es} process belongs.
- `cfs_period_micros` (Linux only)::
- (integer)
- The period of time (in microseconds) for how regularly all tasks in the same
- cgroup as the {es} process should have their access to CPU resources
- reallocated.
- `cfs_quota_micros` (Linux only)::
- (integer)
- The total amount of time (in microseconds) for which all tasks in
- the same cgroup as the {es} process can run during one period
- `cfs_period_micros`.
- `stat` (Linux only)::
- (object)
- Contains CPU statistics for the node.
- +
- .Properties of `stat`
- [%collapsible%open]
- =========
- `number_of_elapsed_periods` (Linux only)::
- (integer)
- The number of reporting periods (as specified by
- `cfs_period_micros`) that have elapsed.
- `number_of_times_throttled` (Linux only)::
- (integer)
- The number of times all tasks in the same cgroup as the {es} process have
- been throttled.
- `time_throttled_nanos` (Linux only)::
- (integer)
- The total amount of time (in nanoseconds) for which all tasks in the same
- cgroup as the {es} process have been throttled.
- =========
- ========
- `memory` (Linux only)::
- (object)
- Contains statistics about the `memory` control group for the node.
- +
- .Properties of `memory`
- [%collapsible%open]
- ========
- `control_group` (Linux only)::
- (string)
- The `memory` control group to which the {es} process belongs.
- `limit_in_bytes` (Linux only)::
- (string)
- The maximum amount of user memory (including file cache) allowed for all
- tasks in the same cgroup as the {es} process. This value can be too big to
- store in a `long`, so is returned as a string so that the value returned can
- exactly match what the underlying operating system interface returns. Any
- value that is too large to parse into a `long` almost certainly means no
- limit has been set for the cgroup.
- `usage_in_bytes` (Linux only)::
- (string)
- The total current memory usage by processes in the cgroup (in bytes) by all
- tasks in the same cgroup as the {es} process. This value is stored as a
- string for consistency with `limit_in_bytes`.
- ========
- =======
- ======
- [[cluster-nodes-stats-api-response-body-process]]
- `process`::
- (object)
- Contains process statistics for the node.
- +
- .Properties of `process`
- [%collapsible%open]
- ======
- `timestamp`::
- (integer)
- Last time the statistics were refreshed. Recorded in milliseconds
- since the {wikipedia}/Unix_time[Unix Epoch].
- `open_file_descriptors`::
- (integer)
- Number of opened file descriptors associated with the current or
- `-1` if not supported.
- `max_file_descriptors`::
- (integer)
- Maximum number of file descriptors allowed on the system, or `-1` if not
- supported.
- `cpu`::
- (object)
- Contains CPU statistics for the node.
- +
- .Properties of `cpu`
- [%collapsible%open]
- =======
- `percent`::
- (integer)
- CPU usage in percent, or `-1` if not known at the time the stats are
- computed.
- `total`::
- (<<time-units,time value>>)
- CPU time used by the process on which the Java virtual machine is running.
- `total_in_millis`::
- (integer)
- CPU time (in milliseconds) used by the process on which the Java virtual
- machine is running, or `-1` if not supported.
- =======
- `mem`::
- (object)
- Contains virtual memory statistics for the node.
- +
- .Properties of `mem`
- [%collapsible%open]
- =======
- `total_virtual`::
- (<<byte-units,byte value>>)
- Size of virtual memory that is guaranteed to be available to the
- running process.
- `total_virtual_in_bytes`::
- (integer)
- Size in bytes of virtual memory that is guaranteed to be available to the
- running process.
- =======
- ======
- [[cluster-nodes-stats-api-response-body-jvm]]
- `jvm`::
- (object)
- Contains Java Virtual Machine (JVM) statistics for the node.
- +
- .Properties of `jvm`
- [%collapsible%open]
- ======
- `timestamp`::
- (integer)
- Last time JVM statistics were refreshed.
- `uptime`::
- (<<time-units,time value>>)
- JVM uptime.
- `uptime_in_millis`::
- (integer)
- JVM uptime in milliseconds.
- `mem`::
- (object)
- Contains JVM memory usage statistics for the node.
- +
- .Properties of `mem`
- [%collapsible%open]
- =======
- `heap_used`::
- (<<byte-units,byte value>>)
- Memory currently in use by the heap.
- `heap_used_in_bytes`::
- (integer)
- Memory, in bytes, currently in use by the heap.
- `heap_used_percent`::
- (integer)
- Percentage of memory currently in use by the heap.
- `heap_committed`::
- (<<byte-units,byte value>>)
- Amount of memory available for use by the heap.
- `heap_committed_in_bytes`::
- (integer)
- Amount of memory, in bytes, available for use by the heap.
- `heap_max`::
- (<<byte-units,byte value>>)
- Maximum amount of memory available for use by the heap.
- `heap_max_in_bytes`::
- (integer)
- Maximum amount of memory, in bytes, available for use by the heap.
- `non_heap_used`::
- (<<byte-units,byte value>>)
- Non-heap memory used.
- `non_heap_used_in_bytes`::
- (integer)
- Non-heap memory used, in bytes.
- `non_heap_committed`::
- (<<byte-units,byte value>>)
- Amount of non-heap memory available.
- `non_heap_committed_in_bytes`::
- (integer)
- Amount of non-heap memory available, in bytes.
- `pools`::
- (object)
- Contains statistics about heap memory usage for the node.
- +
- .Properties of `pools`
- [%collapsible%open]
- ========
- `young`::
- (object)
- Contains statistics about memory usage by the young generation heap for the
- node.
- +
- .Properties of `young`
- [%collapsible%open]
- =========
- `used`::
- (<<byte-units,byte value>>)
- Memory used by the young generation heap.
- `used_in_bytes`::
- (integer)
- Memory, in bytes, used by the young generation heap.
- `max`::
- (<<byte-units,byte value>>)
- Maximum amount of memory available for use by the young generation heap.
- `max_in_bytes`::
- (integer)
- Maximum amount of memory, in bytes, available for use by the young generation
- heap.
- `peak_used`::
- (<<byte-units,byte value>>)
- Largest amount of memory historically used by the young generation heap.
- `peak_used_in_bytes`::
- (integer)
- Largest amount of memory, in bytes, historically used by the young generation
- heap.
- `peak_max`::
- (<<byte-units,byte value>>)
- Largest amount of memory historically used by the young generation heap.
- `peak_max_in_bytes`::
- (integer)
- Largest amount of memory, in bytes, historically used by the young generation
- heap.
- =========
- `survivor`::
- (object)
- Contains statistics about memory usage by the survivor space for the node.
- +
- .Properties of `survivor`
- [%collapsible%open]
- =========
- `used`::
- (<<byte-units,byte value>>)
- Memory used by the survivor space.
- `used_in_bytes`::
- (integer)
- Memory, in bytes, used by the survivor space.
- `max`::
- (<<byte-units,byte value>>)
- Maximum amount of memory available for use by the survivor space.
- `max_in_bytes`::
- (integer)
- Maximum amount of memory, in bytes, available for use by the survivor space.
- `peak_used`::
- (<<byte-units,byte value>>)
- Largest amount of memory historically used by the survivor space.
- `peak_used_in_bytes`::
- (integer)
- Largest amount of memory, in bytes, historically used by the survivor space.
- `peak_max`::
- (<<byte-units,byte value>>)
- Largest amount of memory historically used by the survivor space.
- `peak_max_in_bytes`::
- (integer)
- Largest amount of memory, in bytes, historically used by the survivor space.
- =========
- `old`::
- (object)
- Contains statistics about memory usage by the old generation heap for the node.
- +
- .Properties of `old`
- [%collapsible%open]
- =========
- `used`::
- (<<byte-units,byte value>>)
- Memory used by the old generation heap.
- `used_in_bytes`::
- (integer)
- Memory, in bytes, used by the old generation heap.
- `max`::
- (<<byte-units,byte value>>)
- Maximum amount of memory available for use by the old generation heap.
- `max_in_bytes`::
- (integer)
- Maximum amount of memory, in bytes, available for use by the old generation
- heap.
- `peak_used`::
- (<<byte-units,byte value>>)
- Largest amount of memory historically used by the old generation heap.
- `peak_used_in_bytes`::
- (integer)
- Largest amount of memory, in bytes, historically used by the old generation
- heap.
- `peak_max`::
- (<<byte-units,byte value>>)
- Highest memory limit historically available for use by the old generation heap.
- `peak_max_in_bytes`::
- (integer)
- Highest memory limit, in bytes, historically available for use by the old
- generation heap.
- =========
- ========
- =======
- `threads`::
- (object)
- Contains statistics about JVM thread usage for the node.
- +
- .Properties of `threads`
- [%collapsible%open]
- =======
- `count`::
- (integer)
- Number of active threads in use by JVM.
- `peak_count`::
- (integer)
- Highest number of threads used by JVM.
- =======
- `gc`::
- (object)
- Contains statistics about JVM garbage collectors for the node.
- +
- .Properties of `gc`
- [%collapsible%open]
- =======
- `collectors`::
- (object)
- Contains statistics about JVM garbage collectors for the node.
- +
- .Properties of `collectors`
- [%collapsible%open]
- ========
- `young`::
- (object)
- Contains statistics about JVM garbage collectors that collect young generation
- objects for the node.
- +
- .Properties of `young`
- [%collapsible%open]
- =========
- `collection_count`::
- (integer)
- Number of JVM garbage collectors that collect young generation objects.
- `collection_time`::
- (<<time-units,time value>>)
- Total time spent by JVM collecting young generation objects.
- `collection_time_in_millis`::
- (integer)
- Total time in milliseconds spent by JVM collecting young generation objects.
- =========
- `old`::
- (object)
- Contains statistics about JVM garbage collectors that collect old generation
- objects for the node.
- +
- .Properties of `old`
- [%collapsible%open]
- =========
- `collection_count`::
- (integer)
- Number of JVM garbage collectors that collect old generation objects.
- `collection_time`::
- (<<time-units,time value>>)
- Total time spent by JVM collecting old generation objects.
- `collection_time_in_millis`::
- (integer)
- Total time in milliseconds spent by JVM collecting old generation objects.
- =========
- ========
- =======
- `buffer_pools`::
- (object)
- Contains statistics about JVM buffer pools for the node.
- +
- .Properties of `buffer_pools`
- [%collapsible%open]
- =======
- `mapped`::
- (object)
- Contains statistics about mapped JVM buffer pools for the node.
- +
- .Properties of `mapped`
- [%collapsible%open]
- ========
- `count`::
- (integer)
- Number of mapped buffer pools.
- `used`::
- (<<byte-units,byte value>>)
- Size of mapped buffer pools.
- `used_in_bytes`::
- (integer)
- Size, in bytes, of mapped buffer pools.
- `total_capacity`::
- (<<byte-units,byte value>>)
- Total capacity of mapped buffer pools.
- `total_capacity_in_bytes`::
- (integer)
- Total capacity, in bytes, of mapped buffer pools.
- ========
- `direct`::
- (object)
- Contains statistics about direct JVM buffer pools for the node.
- +
- .Properties of `direct`
- [%collapsible%open]
- ========
- `count`::
- (integer)
- Number of direct buffer pools.
- `used`::
- (<<byte-units,byte value>>)
- Size of direct buffer pools.
- `used_in_bytes`::
- (integer)
- Size, in bytes, of direct buffer pools.
- `total_capacity`::
- (<<byte-units,byte value>>)
- Total capacity of direct buffer pools.
- `total_capacity_in_bytes`::
- (integer)
- Total capacity, in bytes, of direct buffer pools.
- ========
- =======
- `classes`::
- (object)
- Contains statistics about classes loaded by JVM for the node.
- +
- .Properties of `classes`
- [%collapsible%open]
- =======
- `current_loaded_count`::
- (integer)
- Number of classes currently loaded by JVM.
- `total_loaded_count`::
- (integer)
- Total number of classes loaded since the JVM started.
- `total_unloaded_count`::
- (integer)
- Total number of classes unloaded since the JVM started.
- =======
- ======
- [[cluster-nodes-stats-api-response-body-threadpool]]
- `thread_pool`::
- (object)
- Contains thread pool statistics for the node
- +
- .Properties of `thread_pool`
- [%collapsible%open]
- ======
- `<thread_pool_name>`::
- (object)
- Contains statistics about the thread pool for the node.
- +
- .Properties of `<thread_pool_name>`
- [%collapsible%open]
- =======
- `threads`::
- (integer)
- Number of threads in the thread pool.
- `queue`::
- (integer)
- Number of tasks in queue for the thread pool.
- `active`::
- (integer)
- Number of active threads in the thread pool.
- `rejected`::
- (integer)
- Number of tasks rejected by the thread pool executor.
- `largest`::
- (integer)
- Highest number of active threads in the thread pool.
- `completed`::
- (integer)
- Number of tasks completed by the thread pool executor.
- =======
- ======
- [[cluster-nodes-stats-api-response-body-fs]]
- `fs`::
- (object)
- Contains file store statistics for the node.
- +
- .Properties of `fs`
- [%collapsible%open]
- ======
- `timestamp`::
- (integer)
- Last time the file stores statistics were refreshed. Recorded in
- milliseconds since the {wikipedia}/Unix_time[Unix Epoch].
- `total`::
- (object)
- Contains statistics for all file stores of the node.
- +
- .Properties of `total`
- [%collapsible%open]
- =======
- `total`::
- (<<byte-units,byte value>>)
- Total size of all file stores.
- `total_in_bytes`::
- (integer)
- Total size (in bytes) of all file stores.
- `free`::
- (<<byte-units,byte value>>)
- Total unallocated disk space in all file stores.
- `free_in_bytes`::
- (integer)
- Total number of unallocated bytes in all file stores.
- `available`::
- (<<byte-units,byte value>>)
- Total disk space available to this Java virtual machine on all file
- stores. Depending on OS or process level restrictions, this might appear
- less than `free`. This is the actual amount of free disk
- space the {es} node can utilise.
- `available_in_bytes`::
- (integer)
- Total number of bytes available to this Java virtual machine on all file
- stores. Depending on OS or process level restrictions, this might appear
- less than `free_in_bytes`. This is the actual amount of free disk
- space the {es} node can utilise.
- =======
- [[cluster-nodes-stats-fs-data]]
- `data`::
- (array of objects)
- List of all file stores.
- +
- .Properties of `data`
- [%collapsible%open]
- =======
- `path`::
- (string)
- Path to the file store.
- `mount`::
- (string)
- Mount point of the file store (ex: /dev/sda2).
- `type`::
- (string)
- Type of the file store (ex: ext4).
- `total`::
- (<<byte-units,byte value>>)
- Total size of the file store.
- `total_in_bytes`::
- (integer)
- Total size (in bytes) of the file store.
- `free`::
- (<<byte-units,byte value>>)
- Total amount of unallocated disk space in the file store.
- `free_in_bytes`::
- (integer)
- Total number of unallocated bytes in the file store.
- `available`::
- (<<byte-units,byte value>>)
- Total amount of disk space available to this Java virtual machine on this file
- store.
- `available_in_bytes`::
- (integer)
- Total number of bytes available to this Java virtual machine on this file
- store.
- =======
- `io_stats` (Linux only)::
- (objects)
- Contains I/O statistics for the node.
- +
- .Properties of `io_stats`
- [%collapsible%open]
- =======
- `devices` (Linux only)::
- (array)
- Array of disk metrics for each device that is backing an {es} data path.
- These disk metrics are probed periodically and averages between the last
- probe and the current probe are computed.
- +
- .Properties of `devices`
- [%collapsible%open]
- ========
- `device_name` (Linux only)::
- (string)
- The Linux device name.
- `operations` (Linux only)::
- (integer)
- The total number of read and write operations for the device completed since
- starting {es}.
- `read_operations` (Linux only)::
- (integer)
- The total number of read operations for the device completed since starting
- {es}.
- `write_operations` (Linux only)::
- (integer)
- The total number of write operations for the device completed since starting
- {es}.
- `read_kilobytes` (Linux only)::
- (integer)
- The total number of kilobytes read for the device since starting {es}.
- `write_kilobytes` (Linux only)::
- (integer)
- The total number of kilobytes written for the device since starting {es}.
- ========
- `operations` (Linux only)::
- (integer)
- The total number of read and write operations across all devices used by
- {es} completed since starting {es}.
- `read_operations` (Linux only)::
- (integer)
- The total number of read operations for across all devices used by {es}
- completed since starting {es}.
- `write_operations` (Linux only)::
- (integer)
- The total number of write operations across all devices used by {es}
- completed since starting {es}.
- `read_kilobytes` (Linux only)::
- (integer)
- The total number of kilobytes read across all devices used by {es} since
- starting {es}.
- `write_kilobytes` (Linux only)::
- (integer)
- The total number of kilobytes written across all devices used by {es} since
- starting {es}.
- =======
- ======
- [[cluster-nodes-stats-api-response-body-transport]]
- `transport`::
- (object)
- Contains transport statistics for the node.
- +
- .Properties of `transport`
- [%collapsible%open]
- ======
- `server_open`::
- (integer)
- Current number of inbound TCP connections used for internal communication between nodes.
- `total_outbound_connections`::
- (integer)
- The cumulative number of outbound transport connections that this node has
- opened since it started. Each transport connection may comprise multiple TCP
- connections but is only counted once in this statistic. Transport connections
- are typically <<long-lived-connections,long-lived>> so this statistic should
- remain constant in a stable cluster.
- `rx_count`::
- (integer)
- Total number of RX (receive) packets received by the node during internal
- cluster communication.
- `rx_size`::
- (<<byte-units,byte value>>)
- Size of RX packets received by the node during internal cluster communication.
- `rx_size_in_bytes`::
- (integer)
- Size, in bytes, of RX packets received by the node during internal cluster
- communication.
- `tx_count`::
- (integer)
- Total number of TX (transmit) packets sent by the node during internal cluster
- communication.
- `tx_size`::
- (<<byte-units,byte value>>)
- Size of TX packets sent by the node during internal cluster communication.
- `tx_size_in_bytes`::
- (integer)
- Size, in bytes, of TX packets sent by the node during internal cluster
- communication.
- ======
- [[cluster-nodes-stats-api-response-body-http]]
- `http`::
- (object)
- Contains http statistics for the node.
- +
- .Properties of `http`
- [%collapsible%open]
- ======
- `current_open`::
- (integer)
- Current number of open HTTP connections for the node.
- `total_opened`::
- (integer)
- Total number of HTTP connections opened for the node.
- ======
- [[cluster-nodes-stats-api-response-body-breakers]]
- `breakers`::
- (object)
- Contains circuit breaker statistics for the node.
- +
- .Properties of `breakers`
- [%collapsible%open]
- ======
- `<circuit_breaker_name>`::
- (object)
- Contains statistics for the circuit breaker.
- +
- .Properties of `<circuit_breaker_name>`
- [%collapsible%open]
- =======
- `limit_size_in_bytes`::
- (integer)
- Memory limit, in bytes, for the circuit breaker.
- `limit_size`::
- (<<byte-units,byte value>>)
- Memory limit for the circuit breaker.
- `estimated_size_in_bytes`::
- (integer)
- Estimated memory used, in bytes, for the operation.
- `estimated_size`::
- (<<byte-units,byte value>>)
- Estimated memory used for the operation.
- `overhead`::
- (float)
- A constant that all estimates for the circuit breaker are multiplied with to
- calculate a final estimate.
- `tripped`::
- (integer)
- Total number of times the circuit breaker has been triggered and prevented an
- out of memory error.
- =======
- ======
- [[cluster-nodes-stats-api-response-body-script]]
- `script`::
- (object)
- Contains script statistics for the node.
- +
- .Properties of `script`
- [%collapsible%open]
- ======
- `compilations`::
- (integer)
- Total number of inline script compilations performed by the node.
- `cache_evictions`::
- (integer)
- Total number of times the script cache has evicted old data.
- `compilation_limit_triggered`::
- (integer)
- Total number of times the <<script-compilation-circuit-breaker,script
- compilation>> circuit breaker has limited inline script compilations.
- ======
- [[cluster-nodes-stats-api-response-body-discovery]]
- `discovery`::
- (object)
- Contains node discovery statistics for the node.
- +
- .Properties of `discovery`
- [%collapsible%open]
- ======
- `cluster_state_queue`::
- (object)
- Contains statistics for the cluster state queue of the node.
- +
- .Properties of `cluster_state_queue`
- [%collapsible%open]
- =======
- `total`::
- (integer)
- Total number of cluster states in queue.
- `pending`::
- (integer)
- Number of pending cluster states in queue.
- `committed`::
- (integer)
- Number of committed cluster states in queue.
- =======
- `published_cluster_states`::
- (object)
- Contains statistics for the published cluster states of the node.
- +
- .Properties of `published_cluster_states`
- [%collapsible%open]
- =======
- `full_states`::
- (integer)
- Number of published cluster states.
- `incompatible_diffs`::
- (integer)
- Number of incompatible differences between published cluster states.
- `compatible_diffs`::
- (integer)
- Number of compatible differences between published cluster states.
- =======
- ======
- [[cluster-nodes-stats-api-response-body-ingest]]
- `ingest`::
- (object)
- Contains ingest statistics for the node.
- +
- .Properties of `ingest`
- [%collapsible%open]
- ======
- `total`::
- (object)
- Contains statistics about ingest operations for the node.
- +
- .Properties of `total`
- [%collapsible%open]
- =======
- `count`::
- (integer)
- Total number of documents ingested during the lifetime of this node.
- `time`::
- (<<time-units,time value>>)
- Total time spent preprocessing ingest documents during the lifetime of this
- node.
- `time_in_millis`::
- (integer)
- Total time, in milliseconds, spent preprocessing ingest documents during the
- lifetime of this node.
- `current`::
- (integer)
- Total number of documents currently being ingested.
- `failed`::
- (integer)
- Total number of failed ingest operations during the lifetime of this node.
- =======
- `pipelines`::
- (object)
- Contains statistics about ingest pipelines for the node.
- +
- .Properties of `pipelines`
- [%collapsible%open]
- =======
- `<pipeline_id>`::
- (object)
- Contains statistics about the ingest pipeline.
- +
- .Properties of `<pipeline_id>`
- [%collapsible%open]
- ========
- `count`::
- (integer)
- Number of documents preprocessed by the ingest pipeline.
- `time`::
- (<<time-units,time value>>)
- Total time spent preprocessing documents in the ingest pipeline.
- `time_in_millis`::
- (integer)
- Total time, in milliseconds, spent preprocessing documents in the ingest
- pipeline.
- `failed`::
- (integer)
- Total number of failed operations for the ingest pipeline.
- `processors`::
- (array of objects)
- Contains statistics for the ingest processors for the ingest pipeline.
- +
- .Properties of `processors`
- [%collapsible%open]
- =========
- `<processor>`::
- (object)
- Contains statistics for the ingest processor.
- +
- .Properties of `<processor>`
- [%collapsible%open]
- ==========
- `count`::
- (integer)
- Number of documents transformed by the processor.
- `time`::
- (<<time-units,time value>>)
- Time spent by the processor transforming documents.
- `time_in_millis`::
- (integer)
- Time, in milliseconds, spent by the processor transforming documents.
- `current`::
- (integer)
- Number of documents currently being transformed by the processor.
- `failed`::
- (integer)
- Number of failed operations for the processor.
- ==========
- =========
- ========
- =======
- ======
- [[cluster-nodes-stats-api-response-body-indexing-pressure]]
- `indexing_pressure`::
- (object)
- Contains <<index-modules-indexing-pressure,indexing pressure>> statistics for the node.
- +
- .Properties of `indexing_pressure`
- [%collapsible%open]
- ======
- `memory`::
- (object)
- Contains statistics for memory consumption from indexing load.
- +
- .Properties of `<memory>`
- [%collapsible%open]
- =======
- `current`::
- (object)
- Contains statistics for current indexing load.
- +
- .Properties of `<current>`
- [%collapsible%open]
- ========
- `combined_coordinating_and_primary`::
- (<<byte-units,byte value>>)
- Memory consumed by indexing requests in the coordinating or primary stage. This
- value is not the sum of coordinating and primary as a node can reuse the
- coordinating memory if the primary stage is executed locally.
- `combined_coordinating_and_primary_in_bytes`::
- (integer)
- Memory consumed, in bytes, by indexing requests in the coordinating or primary
- stage. This value is not the sum of coordinating and primary as a node can
- reuse the coordinating memory if the primary stage is executed locally.
- `coordinating`::
- (<<byte-units,byte value>>)
- Memory consumed by indexing requests in the coordinating stage.
- `coordinating_in_bytes`::
- (integer)
- Memory consumed, in bytes, by indexing requests in the coordinating stage.
- `primary`::
- (<<byte-units,byte value>>)
- Memory consumed by indexing requests in the primary stage.
- `primary_in_bytes`::
- (integer)
- Memory consumed, in bytes, by indexing requests in the primary stage.
- `replica`::
- (<<byte-units,byte value>>)
- Memory consumed by indexing requests in the replica stage.
- `replica_in_bytes`::
- (integer)
- Memory consumed, in bytes, by indexing requests in the replica stage.
- `all`::
- (<<byte-units,byte value>>)
- Memory consumed by indexing requests in the coordinating, primary, or replica stage.
- `all_in_bytes`::
- (integer)
- Memory consumed, in bytes, by indexing requests in the coordinating, primary,
- or replica stage.
- ========
- `total`::
- (object)
- Contains statistics for the cumulative indexing load since the node started.
- +
- .Properties of `<total>`
- [%collapsible%open]
- ========
- `combined_coordinating_and_primary`::
- (<<byte-units,byte value>>)
- Memory consumed by indexing requests in the coordinating or primary stage. This
- value is not the sum of coordinating and primary as a node can reuse the
- coordinating memory if the primary stage is executed locally.
- `combined_coordinating_and_primary_in_bytes`::
- (integer)
- Memory consumed, in bytes, by indexing requests in the coordinating or primary
- stage. This value is not the sum of coordinating and primary as a node can
- reuse the coordinating memory if the primary stage is executed locally.
- `coordinating`::
- (<<byte-units,byte value>>)
- Memory consumed by indexing requests in the coordinating stage.
- `coordinating_in_bytes`::
- (integer)
- Memory consumed, in bytes, by indexing requests in the coordinating stage.
- `primary`::
- (<<byte-units,byte value>>)
- Memory consumed by indexing requests in the primary stage.
- `primary_in_bytes`::
- (integer)
- Memory consumed, in bytes, by indexing requests in the primary stage.
- `replica`::
- (<<byte-units,byte value>>)
- Memory consumed by indexing requests in the replica stage.
- `replica_in_bytes`::
- (integer)
- Memory consumed, in bytes, by indexing requests in the replica stage.
- `all`::
- (<<byte-units,byte value>>)
- Memory consumed by indexing requests in the coordinating, primary, or replica stage.
- `all_in_bytes`::
- (integer)
- Memory consumed, in bytes, by indexing requests in the coordinating, primary,
- or replica stage.
- `coordinating_rejections`::
- (integer)
- Number of indexing requests rejected in the coordinating stage.
- `primary_rejections`::
- (integer)
- Number of indexing requests rejected in the primary stage.
- `replica_rejections`::
- (integer)
- Number of indexing requests rejected in the replica stage.
- ========
- `limit`::
- (<<byte-units,byte value>>)
- Configured memory limit for the indexing requests. Replica requests have an
- automatic limit that is 1.5x this value.
- `limit_in_bytes`::
- (integer)
- Configured memory limit, in bytes, for the indexing requests. Replica requests
- have an automatic limit that is 1.5x this value.
- =======
- ======
- [[cluster-nodes-stats-api-response-body-adaptive-selection]]
- `adaptive_selection`::
- (object)
- Contains adaptive selection statistics for the node.
- +
- .Properties of `adaptive_selection`
- [%collapsible%open]
- ======
- `outgoing_searches`::
- (integer)
- The number of outstanding search requests from the node these stats are for
- to the keyed node.
- `avg_queue_size`::
- (integer)
- The exponentially weighted moving average queue size of search requests on
- the keyed node.
- `avg_service_time`::
- (<<time-units,time value>>)
- The exponentially weighted moving average service time of search requests on
- the keyed node.
- `avg_service_time_ns`::
- (integer)
- The exponentially weighted moving average service time, in nanoseconds, of
- search requests on the keyed node.
- `avg_response_time`::
- (<<time-units,time value>>)
- The exponentially weighted moving average response time of search requests
- on the keyed node.
- `avg_response_time_ns`::
- (integer)
- The exponentially weighted moving average response time, in nanoseconds, of
- search requests on the keyed node.
- `rank`::
- (string)
- The rank of this node; used for shard selection when routing search
- requests.
- ======
- =====
- ====
- [[cluster-nodes-stats-api-example]]
- ==== {api-examples-title}
- [source,console]
- --------------------------------------------------
- # return just indices
- GET /_nodes/stats/indices
- # return just os and process
- GET /_nodes/stats/os,process
- # return just process for node with IP address 10.0.0.1
- GET /_nodes/10.0.0.1/stats/process
- --------------------------------------------------
- All stats can be explicitly requested via `/_nodes/stats/_all` or
- `/_nodes/stats?metric=_all`.
- You can get information about indices stats on `node`, `indices`, or `shards`
- level.
- [source,console]
- --------------------------------------------------
- # Fielddata summarized by node
- GET /_nodes/stats/indices/fielddata?fields=field1,field2
- # Fielddata summarized by node and index
- GET /_nodes/stats/indices/fielddata?level=indices&fields=field1,field2
- # Fielddata summarized by node, index, and shard
- GET /_nodes/stats/indices/fielddata?level=shards&fields=field1,field2
- # You can use wildcards for field names
- GET /_nodes/stats/indices/fielddata?fields=field*
- --------------------------------------------------
- You can get statistics about search groups for searches executed
- on this node.
- [source,console]
- --------------------------------------------------
- # All groups with all stats
- GET /_nodes/stats?groups=_all
- # Some groups from just the indices stats
- GET /_nodes/stats/indices?groups=foo,bar
- --------------------------------------------------
- [[cluster-nodes-stats-ingest-ex]]
- ===== Retrieve ingest statistics only
- To return only ingest-related node statistics, set the `<metric>` path
- parameter to `ingest` and use the
- <<common-options-response-filtering,`filter_path`>> query parameter.
- [source,console]
- --------------------------------------------------
- GET /_nodes/stats/ingest?filter_path=nodes.*.ingest
- --------------------------------------------------
- You can use the `metric` and `filter_path` query parameters to get the same
- response.
- [source,console]
- --------------------------------------------------
- GET /_nodes/stats?metric=ingest&filter_path=nodes.*.ingest
- --------------------------------------------------
- To further refine the response, change the `filter_path` value.
- For example, the following request only returns ingest pipeline statistics.
- [source,console]
- --------------------------------------------------
- GET /_nodes/stats?metric=ingest&filter_path=nodes.*.ingest.pipelines
- --------------------------------------------------
|