nodes-stats.asciidoc 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367
  1. [[cluster-nodes-stats]]
  2. === Nodes stats API
  3. ++++
  4. <titleabbrev>Nodes stats</titleabbrev>
  5. ++++
  6. Returns cluster nodes statistics.
  7. [[cluster-nodes-stats-api-request]]
  8. ==== {api-request-title}
  9. `GET /_nodes/stats` +
  10. `GET /_nodes/<node_id>/stats` +
  11. `GET /_nodes/stats/<metric>` +
  12. `GET /_nodes/<node_id>/stats/<metric>` +
  13. `GET /_nodes/stats/<metric>/<index_metric>` +
  14. `GET /_nodes/<node_id>/stats/<metric>/<index_metric>`
  15. [[cluster-nodes-stats-api-prereqs]]
  16. ==== {api-prereq-title}
  17. * If the {es} {security-features} are enabled, you must have the `monitor` or
  18. `manage` <<privileges-list-cluster,cluster privilege>> to use this API.
  19. [[cluster-nodes-stats-api-desc]]
  20. ==== {api-description-title}
  21. You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster.
  22. All the nodes selective options are explained <<cluster-nodes,here>>.
  23. By default, all stats are returned. You can limit the returned information by
  24. using metrics.
  25. [[cluster-nodes-stats-api-path-params]]
  26. ==== {api-path-parms-title}
  27. `<metric>`::
  28. (Optional, string) Limits the information returned to the specific metrics.
  29. A comma-separated list of the following options:
  30. +
  31. --
  32. `adaptive_selection`::
  33. Statistics about <<search-adaptive-replica,adaptive replica selection>>.
  34. `breaker`::
  35. Statistics about the field data circuit breaker.
  36. `discovery`::
  37. Statistics about the discovery.
  38. `fs`::
  39. File system information, data path, free disk space, read/write
  40. stats.
  41. `http`::
  42. HTTP connection information.
  43. `indexing_pressure`::
  44. Statistics about the node's indexing load and related rejections.
  45. `indices`::
  46. Indices stats about size, document count, indexing and deletion times,
  47. search times, field cache size, merges and flushes.
  48. `ingest`::
  49. Statistics about ingest preprocessing.
  50. `jvm`::
  51. JVM stats, memory pool information, garbage collection, buffer
  52. pools, number of loaded/unloaded classes.
  53. `os`::
  54. Operating system stats, load average, mem, swap.
  55. `process`::
  56. Process statistics, memory consumption, cpu usage, open
  57. file descriptors.
  58. `thread_pool`::
  59. Statistics about each thread pool, including current size, queue and
  60. rejected tasks.
  61. `transport`::
  62. Transport statistics about sent and received bytes in cluster
  63. communication.
  64. --
  65. `<index_metric>`::
  66. (Optional, string) Limit the information returned for `indices` metric to
  67. the specific index metrics. It can be used only if `indices` (or `all`)
  68. metric is specified. Supported metrics are:
  69. +
  70. --
  71. * `completion`
  72. * `docs`
  73. * `fielddata`
  74. * `flush`
  75. * `get`
  76. * `indexing`
  77. * `merge`
  78. * `query_cache`
  79. * `recovery`
  80. * `refresh`
  81. * `request_cache`
  82. * `search`
  83. * `segments`
  84. * `store`
  85. * `translog`
  86. * `warmer`
  87. --
  88. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
  89. [[cluster-nodes-stats-api-query-params]]
  90. ==== {api-query-parms-title}
  91. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=completion-fields]
  92. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields]
  93. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields]
  94. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=groups]
  95. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=level]
  96. `types`::
  97. (Optional, string) A comma-separated list of document types for the
  98. `indexing` index metric.
  99. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
  100. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes]
  101. [role="child_attributes"]
  102. [[cluster-nodes-stats-api-response-body]]
  103. ==== {api-response-body-title}
  104. `_nodes`::
  105. (object)
  106. Contains statistics about the number of nodes selected by the request.
  107. +
  108. .Properties of `_nodes`
  109. [%collapsible%open]
  110. ====
  111. `total`::
  112. (integer)
  113. Total number of nodes selected by the request.
  114. `successful`::
  115. (integer)
  116. Number of nodes that responded successfully to the request.
  117. `failed`::
  118. (integer)
  119. Number of nodes that rejected the request or failed to respond. If this value
  120. is not `0`, a reason for the rejection or failure is included in the response.
  121. ====
  122. `cluster_name`::
  123. (string)
  124. Name of the cluster. Based on the <<cluster-name>> setting.
  125. `nodes`::
  126. (object)
  127. Contains statistics for the nodes selected by the request.
  128. +
  129. .Properties of `nodes`
  130. [%collapsible%open]
  131. ====
  132. `<node_id>`::
  133. (object)
  134. Contains statistics for the node.
  135. +
  136. .Properties of `<node_id>`
  137. [%collapsible%open]
  138. =====
  139. `timestamp`::
  140. (integer)
  141. Time the node stats were collected for this response. Recorded in milliseconds
  142. since the {wikipedia}/Unix_time[Unix Epoch].
  143. `name`::
  144. (string)
  145. Human-readable identifier for the node. Based on the <<node-name>> setting.
  146. `transport_address`::
  147. (string)
  148. Host and port for the <<modules-transport,transport layer>>, used for internal
  149. communication between nodes in a cluster.
  150. `host`::
  151. (string)
  152. Network host for the node, based on the <<network.host>> setting.
  153. `ip`::
  154. (string)
  155. IP address and port for the node.
  156. `roles`::
  157. (array of strings)
  158. Roles assigned to the node. See <<modules-node>>.
  159. `attributes`::
  160. (object)
  161. Contains a list of attributes for the node.
  162. [[cluster-nodes-stats-api-response-body-indices]]
  163. `indices`::
  164. (object)
  165. Contains statistics about indices with shards assigned to the node.
  166. +
  167. .Properties of `indices`
  168. [%collapsible%open]
  169. ======
  170. `docs`::
  171. (object)
  172. Contains statistics about documents across all primary shards assigned to the
  173. node.
  174. +
  175. .Properties of `docs`
  176. [%collapsible%open]
  177. =======
  178. `count`::
  179. (integer)
  180. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-count]
  181. `deleted`::
  182. (integer)
  183. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted]
  184. =======
  185. `store`::
  186. (object)
  187. Contains statistics about the size of shards assigned to the node.
  188. +
  189. .Properties of `store`
  190. [%collapsible%open]
  191. =======
  192. `size`::
  193. (<<byte-units,byte value>>)
  194. Total size of all shards assigned to the node.
  195. `size_in_bytes`::
  196. (integer)
  197. Total size, in bytes, of all shards assigned to the node.
  198. `reserved`::
  199. (<<byte-units,byte value>>)
  200. A prediction of how much larger the shard stores on this node will eventually
  201. grow due to ongoing peer recoveries, restoring snapshots, and similar
  202. activities. A value of `-1b` indicates that this is not available.
  203. `reserved_in_bytes`::
  204. (integer)
  205. A prediction, in bytes, of how much larger the shard stores on this node will
  206. eventually grow due to ongoing peer recoveries, restoring snapshots, and
  207. similar activities. A value of `-1` indicates that this is not available.
  208. =======
  209. `indexing`::
  210. (object)
  211. Contains statistics about indexing operations for the node.
  212. +
  213. .Properties of `indexing`
  214. [%collapsible%open]
  215. =======
  216. `index_total`::
  217. (integer)
  218. Total number of indexing operations.
  219. `index_time`::
  220. (<<time-units,time value>>)
  221. Total time spent performing indexing operations.
  222. `index_time_in_millis`::
  223. (integer)
  224. Total time in milliseconds
  225. spent performing indexing operations.
  226. `index_current`::
  227. (integer)
  228. Number of indexing operations currently running.
  229. `index_failed`::
  230. (integer)
  231. Number of failed indexing operations.
  232. `delete_total`::
  233. (integer)
  234. Total number of deletion operations.
  235. `delete_time`::
  236. (<<time-units,time value>>)
  237. Time spent performing deletion operations.
  238. `delete_time_in_millis`::
  239. (integer)
  240. Time in milliseconds
  241. spent performing deletion operations.
  242. `delete_current`::
  243. (integer)
  244. Number of deletion operations currently running.
  245. `noop_update_total`::
  246. (integer)
  247. Total number of noop operations.
  248. `is_throttled`::
  249. (Boolean)
  250. Number of times
  251. operations were throttled.
  252. `throttle_time`::
  253. (<<time-units,time value>>)
  254. Total time spent throttling operations.
  255. `throttle_time_in_millis`::
  256. (integer)
  257. Total time in milliseconds
  258. spent throttling operations.
  259. =======
  260. `get`::
  261. (object)
  262. Contains statistics about get operations for the node.
  263. +
  264. .Properties of `get`
  265. [%collapsible%open]
  266. =======
  267. `total`::
  268. (integer)
  269. Total number of get operations.
  270. `getTime`::
  271. (<<time-units,time value>>)
  272. Time spent performing get operations.
  273. `time_in_millis`::
  274. (integer)
  275. Time in milliseconds
  276. spent performing get operations.
  277. `exists_total`::
  278. (integer)
  279. Total number of successful get operations.
  280. `exists_time`::
  281. (<<time-units,time value>>)
  282. Time spent performing successful get operations.
  283. `exists_time_in_millis`::
  284. (integer)
  285. Time in milliseconds
  286. spent performing successful get operations.
  287. `missing_total`::
  288. (integer)
  289. Total number of failed get operations.
  290. `missing_time`::
  291. (<<time-units,time value>>)
  292. Time spent performing failed get operations.
  293. `missing_time_in_millis`::
  294. (integer)
  295. Time in milliseconds
  296. spent performing failed get operations.
  297. `current`::
  298. (integer)
  299. Number of get operations currently running.
  300. =======
  301. `search`::
  302. (object)
  303. Contains statistics about search operations for the node.
  304. +
  305. .Properties of `search`
  306. [%collapsible%open]
  307. =======
  308. `open_contexts`::
  309. (integer)
  310. Number of open search contexts.
  311. `query_total`::
  312. (integer)
  313. Total number of query operations.
  314. `query_time`::
  315. (<<time-units,time value>>)
  316. Time spent performing query operations.
  317. `query_time_in_millis`::
  318. (integer)
  319. Time in milliseconds
  320. spent performing query operations.
  321. `query_current`::
  322. (integer)
  323. Number of query operations currently running.
  324. `fetch_total`::
  325. (integer)
  326. Total number of fetch operations.
  327. `fetch_time`::
  328. (<<time-units,time value>>)
  329. Time spent performing fetch operations.
  330. `fetch_time_in_millis`::
  331. (integer)
  332. Time in milliseconds
  333. spent performing fetch operations.
  334. `fetch_current`::
  335. (integer)
  336. Number of fetch operations currently running.
  337. `scroll_total`::
  338. (integer)
  339. Total number of scroll operations.
  340. `scroll_time`::
  341. (<<time-units,time value>>)
  342. Time spent performing scroll operations.
  343. `scroll_time_in_millis`::
  344. (integer)
  345. Time in milliseconds
  346. spent performing scroll operations.
  347. `scroll_current`::
  348. (integer)
  349. Number of scroll operations currently running.
  350. `suggest_total`::
  351. (integer)
  352. Total number of suggest operations.
  353. `suggest_time`::
  354. (<<time-units,time value>>)
  355. Time spent performing suggest operations.
  356. `suggest_time_in_millis`::
  357. (integer)
  358. Time in milliseconds
  359. spent performing suggest operations.
  360. `suggest_current`::
  361. (integer)
  362. Number of suggest operations currently running.
  363. =======
  364. `merges`::
  365. (object)
  366. Contains statistics about merge operations for the node.
  367. +
  368. .Properties of `merges`
  369. [%collapsible%open]
  370. =======
  371. `current`::
  372. (integer)
  373. Number of merge operations currently running.
  374. `current_docs`::
  375. (integer)
  376. Number of document merges currently running.
  377. `current_size`::
  378. (<<byte-units,byte value>>)
  379. Memory used performing current document merges.
  380. `current_size_in_bytes`::
  381. (integer)
  382. Memory, in bytes, used performing current document merges.
  383. `total`::
  384. (integer)
  385. Total number of merge operations.
  386. `total_time`::
  387. (<<time-units,time value>>)
  388. Total time spent performing merge operations.
  389. `total_time_in_millis`::
  390. (integer)
  391. Total time in milliseconds
  392. spent performing merge operations.
  393. `total_docs`::
  394. (integer)
  395. Total number of merged documents.
  396. `total_size`::
  397. (<<byte-units,byte value>>)
  398. Total size of document merges.
  399. `total_size_in_bytes`::
  400. (integer)
  401. Total size of document merges in bytes.
  402. `total_stopped_time`::
  403. (<<time-units,time value>>)
  404. Total time spent stopping merge operations.
  405. `total_stopped_time_in_millis`::
  406. (integer)
  407. Total time in milliseconds
  408. spent stopping merge operations.
  409. `total_throttled_time`::
  410. (<<time-units,time value>>)
  411. Total time spent throttling merge operations.
  412. `total_throttled_time_in_millis`::
  413. (integer)
  414. Total time in milliseconds
  415. spent throttling merge operations.
  416. `total_auto_throttle`::
  417. (<<byte-units,byte value>>)
  418. Size of automatically throttled merge operations.
  419. `total_auto_throttle_in_bytes`::
  420. (integer)
  421. Size, in bytes, of automatically throttled merge operations.
  422. =======
  423. `refresh`::
  424. (object)
  425. Contains statistics about refresh operations for the node.
  426. +
  427. .Properties of `refresh`
  428. [%collapsible%open]
  429. =======
  430. `total`::
  431. (integer)
  432. Total number of refresh operations.
  433. `total_time`::
  434. (<<time-units,time value>>)
  435. Total time spent performing refresh operations.
  436. `total_time_in_millis`::
  437. (integer)
  438. Total time in milliseconds
  439. spent performing refresh operations.
  440. `external_total`::
  441. (integer)
  442. Total number of external refresh operations.
  443. `external_total_time`::
  444. (<<time-units,time value>>)
  445. Total time spent performing external operations.
  446. `external_total_time_in_millis`::
  447. (integer)
  448. Total time in milliseconds
  449. spent performing external operations.
  450. `listeners`::
  451. (integer)
  452. Number of refresh listeners.
  453. =======
  454. `flush`::
  455. (object)
  456. Contains statistics about flush operations for the node.
  457. +
  458. .Properties of `flush`
  459. [%collapsible%open]
  460. =======
  461. `total`::
  462. (integer)
  463. Number of flush operations.
  464. `periodic`::
  465. (integer)
  466. Number of flush periodic operations.
  467. `total_time`::
  468. (<<time-units,time value>>)
  469. Total time spent performing flush operations.
  470. `total_time_in_millis`::
  471. (integer)
  472. Total time in milliseconds
  473. spent performing flush operations.
  474. =======
  475. `warmer`::
  476. (object)
  477. Contains statistics about index warming operations for the node.
  478. +
  479. .Properties of `warmer`
  480. [%collapsible%open]
  481. =======
  482. `current`::
  483. (integer)
  484. Number of active index warmers.
  485. `total`::
  486. (integer)
  487. Total number of index warmers.
  488. `total_time`::
  489. (<<time-units,time value>>)
  490. Total time spent performing index warming operations.
  491. `total_time_in_millis`::
  492. (integer)
  493. Total time in milliseconds
  494. spent performing index warming operations.
  495. =======
  496. `query_cache`::
  497. (object)
  498. Contains statistics about the query cache across all shards assigned to the
  499. node.
  500. +
  501. .Properties of `query_cache`
  502. [%collapsible%open]
  503. =======
  504. `memory_size`::
  505. (<<byte-units,byte value>>)
  506. Total amount of memory used for the query cache across all shards assigned to
  507. the node.
  508. `memory_size_in_bytes`::
  509. (integer)
  510. Total amount of memory, in bytes, used for the query cache across all shards
  511. assigned to the node.
  512. `total_count`::
  513. (integer)
  514. Total count of hits, misses, and cached queries
  515. in the query cache.
  516. `hit_count`::
  517. (integer)
  518. Number of query cache hits.
  519. `miss_count`::
  520. (integer)
  521. Number of query cache misses.
  522. `cache_size`::
  523. (integer)
  524. Size, in bytes, of the query cache.
  525. `cache_count`::
  526. (integer)
  527. Count of queries
  528. in the query cache.
  529. `evictions`::
  530. (integer)
  531. Number of query cache evictions.
  532. =======
  533. `fielddata`::
  534. (object)
  535. Contains statistics about the field data cache across all shards
  536. assigned to the node.
  537. +
  538. .Properties of `fielddata`
  539. [%collapsible%open]
  540. =======
  541. `memory_size`::
  542. (<<byte-units,byte value>>)
  543. Total amount of memory used for the field data cache across all shards
  544. assigned to the node.
  545. `memory_size_in_bytes`::
  546. (integer)
  547. Total amount of memory, in bytes, used for the field data cache across all
  548. shards assigned to the node.
  549. `evictions`::
  550. (integer)
  551. Number of fielddata evictions.
  552. =======
  553. `completion`::
  554. (object)
  555. Contains statistics about completions across all shards assigned to the node.
  556. +
  557. .Properties of `completion`
  558. [%collapsible%open]
  559. =======
  560. `size`::
  561. (<<byte-units,byte value>>)
  562. Total amount of memory used for completion across all shards assigned to
  563. the node.
  564. `size_in_bytes`::
  565. (integer)
  566. Total amount of memory, in bytes, used for completion across all shards assigned
  567. to the node.
  568. =======
  569. `segments`::
  570. (object)
  571. Contains statistics about segments across all shards assigned to the node.
  572. +
  573. .Properties of `segments`
  574. [%collapsible%open]
  575. =======
  576. `count`::
  577. (integer)
  578. Number of segments.
  579. `memory`::
  580. (<<byte-units,byte value>>)
  581. Total amount of memory used for segments across all shards assigned to the
  582. node.
  583. `memory_in_bytes`::
  584. (integer)
  585. Total amount of memory, in bytes, used for segments across all shards assigned
  586. to the node.
  587. `terms_memory`::
  588. (<<byte-units,byte value>>)
  589. Total amount of memory used for terms across all shards assigned to the node.
  590. `terms_memory_in_bytes`::
  591. (integer)
  592. Total amount of memory, in bytes, used for terms across all shards assigned to
  593. the node.
  594. `stored_fields_memory`::
  595. (<<byte-units,byte value>>)
  596. Total amount of memory used for stored fields across all shards assigned to
  597. the node.
  598. `stored_fields_memory_in_bytes`::
  599. (integer)
  600. Total amount of memory, in bytes, used for stored fields across all shards
  601. assigned to the node.
  602. `term_vectors_memory`::
  603. (<<byte-units,byte value>>)
  604. Total amount of memory used for term vectors across all shards assigned to
  605. the node.
  606. `term_vectors_memory_in_bytes`::
  607. (integer)
  608. Total amount of memory, in bytes, used for term vectors across all shards
  609. assigned to the node.
  610. `norms_memory`::
  611. (<<byte-units,byte value>>)
  612. Total amount of memory used for normalization factors across all shards assigned
  613. to the node.
  614. `norms_memory_in_bytes`::
  615. (integer)
  616. Total amount of memory, in bytes, used for normalization factors across all
  617. shards assigned to the node.
  618. `points_memory`::
  619. (<<byte-units,byte value>>)
  620. Total amount of memory used for points across all shards assigned to the node.
  621. `points_memory_in_bytes`::
  622. (integer)
  623. Total amount of memory, in bytes, used for points across all shards assigned to
  624. the node.
  625. `doc_values_memory`::
  626. (<<byte-units,byte value>>)
  627. Total amount of memory used for doc values across all shards assigned to
  628. the node.
  629. `doc_values_memory_in_bytes`::
  630. (integer)
  631. Total amount of memory, in bytes, used for doc values across all shards assigned
  632. to the node.
  633. `index_writer_memory`::
  634. (<<byte-units,byte value>>)
  635. Total amount of memory used by all index writers across all shards assigned to
  636. the node.
  637. `index_writer_memory_in_bytes`::
  638. (integer)
  639. Total amount of memory, in bytes, used by all index writers across all shards
  640. assigned to the node.
  641. `version_map_memory`::
  642. (<<byte-units,byte value>>)
  643. Total amount of memory used by all version maps across all shards assigned to
  644. the node.
  645. `version_map_memory_in_bytes`::
  646. (integer)
  647. Total amount of memory, in bytes, used by all version maps across all shards
  648. assigned to the node.
  649. `fixed_bit_set`::
  650. (<<byte-units,byte value>>)
  651. Total amount of memory used by fixed bit sets across all shards assigned to
  652. the node.
  653. +
  654. Fixed bit sets are used for nested object field types and
  655. type filters for <<parent-join,join>> fields.
  656. `fixed_bit_set_memory_in_bytes`::
  657. (integer)
  658. Total amount of memory, in bytes, used by fixed bit sets across all shards
  659. assigned to the node.
  660. +
  661. Fixed bit sets are used for nested object field types and
  662. type filters for <<parent-join,join>> fields.
  663. `max_unsafe_auto_id_timestamp`::
  664. (integer)
  665. Time of the most recently retried indexing request. Recorded in milliseconds
  666. since the {wikipedia}/Unix_time[Unix Epoch].
  667. `file_sizes`::
  668. (object)
  669. Contains statistics about the size of the segment file.
  670. +
  671. .Properties of `file_sizes`
  672. [%collapsible%open]
  673. ========
  674. `size`::
  675. (<<byte-units,byte value>>)
  676. Size of the segment file.
  677. `size_in_bytes`::
  678. (integer)
  679. Size, in bytes,
  680. of the segment file.
  681. `description`::
  682. (string)
  683. Description of the segment file.
  684. ========
  685. =======
  686. `translog`::
  687. (object)
  688. Contains statistics about transaction log operations for the node.
  689. +
  690. .Properties of `translog`
  691. [%collapsible%open]
  692. =======
  693. `operations`::
  694. (integer)
  695. Number of transaction log operations.
  696. `size`::
  697. (<<byte-units,byte value>>)
  698. Size of the transaction log.
  699. `size_in_bytes`::
  700. (integer)
  701. Size, in bytes, of the transaction log.
  702. `uncommitted_operations`::
  703. (integer)
  704. Number of uncommitted transaction log operations.
  705. `uncommitted_size`::
  706. (<<byte-units,byte value>>)
  707. Size of uncommitted transaction log operations.
  708. `uncommitted_size_in_bytes`::
  709. (integer)
  710. Size, in bytes, of uncommitted transaction log operations.
  711. `earliest_last_modified_age`::
  712. (integer)
  713. Earliest last modified age
  714. for the transaction log.
  715. =======
  716. `request_cache`::
  717. (object)
  718. Contains statistics about the request cache across all shards assigned to the
  719. node.
  720. +
  721. .Properties of `request_cache`
  722. [%collapsible%open]
  723. =======
  724. `memory_size`::
  725. (<<byte-units,byte value>>)
  726. Memory used by the request cache.
  727. `memory_size_in_bytes`::
  728. (integer)
  729. Memory, in bytes, used by the request cache.
  730. `evictions`::
  731. (integer)
  732. Number of request cache operations.
  733. `hit_count`::
  734. (integer)
  735. Number of request cache hits.
  736. `miss_count`::
  737. (integer)
  738. Number of request cache misses.
  739. =======
  740. `recovery`::
  741. (object)
  742. Contains statistics about recovery operations for the node.
  743. +
  744. .Properties of `recovery`
  745. [%collapsible%open]
  746. =======
  747. `current_as_source`::
  748. (integer)
  749. Number of recoveries
  750. that used an index shard as a source.
  751. `current_as_target`::
  752. (integer)
  753. Number of recoveries
  754. that used an index shard as a target.
  755. `throttle_time`::
  756. (<<time-units,time value>>)
  757. Time by which recovery operations were delayed due to throttling.
  758. `throttle_time_in_millis`::
  759. (integer)
  760. Time in milliseconds
  761. recovery operations were delayed due to throttling.
  762. =======
  763. ======
  764. [[cluster-nodes-stats-api-response-body-os]]
  765. `os`::
  766. (object)
  767. Contains statistics about the operating system for the node.
  768. +
  769. .Properties of `os`
  770. [%collapsible%open]
  771. ======
  772. `timestamp`::
  773. (integer)
  774. Last time the operating system statistics were refreshed. Recorded in
  775. milliseconds since the {wikipedia}/Unix_time[Unix Epoch].
  776. `cpu`::
  777. (object)
  778. Contains statistics about CPU usage for the node.
  779. +
  780. .Properties of `cpu`
  781. [%collapsible%open]
  782. =======
  783. `percent`::
  784. (integer)
  785. Recent CPU usage for the whole system, or `-1` if not supported.
  786. `load_average`::
  787. (object)
  788. Contains statistics about load averages on the system.
  789. +
  790. .Properties of `load_average`
  791. [%collapsible%open]
  792. ========
  793. `1m`::
  794. (float)
  795. One-minute load average on the system (field is not present if one-minute load
  796. average is not available).
  797. `5m`::
  798. (float)
  799. Five-minute load average on the system (field is not present if five-minute load
  800. average is not available).
  801. `15m`::
  802. (float)
  803. Fifteen-minute load average on the system (field is not present if
  804. fifteen-minute load average is not available).
  805. ========
  806. =======
  807. `mem`::
  808. (object)
  809. Contains statistics about memory usage for the node.
  810. +
  811. .Properties of `mem`
  812. [%collapsible%open]
  813. =======
  814. `total`::
  815. (<<byte-units,byte value>>)
  816. Total amount of physical memory.
  817. `total_in_bytes`::
  818. (integer)
  819. Total amount of physical memory in bytes.
  820. `free`::
  821. (<<byte-units,byte value>>)
  822. Amount of free physical memory.
  823. `free_in_bytes`::
  824. (integer)
  825. Amount of free physical memory in bytes.
  826. `used`::
  827. (<<byte-units,byte value>>)
  828. Amount of used physical memory.
  829. `used_in_bytes`::
  830. (integer)
  831. Amount of used physical memory in bytes.
  832. `free_percent`::
  833. (integer)
  834. Percentage of free memory.
  835. `used_percent`::
  836. (integer)
  837. Percentage of used memory.
  838. =======
  839. `swap`::
  840. (object)
  841. Contains statistics about swap space for the node.
  842. +
  843. .Properties of `swap`
  844. [%collapsible%open]
  845. =======
  846. `total`::
  847. (<<byte-units,byte value>>)
  848. Total amount of swap space.
  849. `total_in_bytes`::
  850. (integer)
  851. Total amount of swap space in bytes.
  852. `free`::
  853. (<<byte-units,byte value>>)
  854. Amount of free swap space.
  855. `free_in_bytes`::
  856. (integer)
  857. Amount of free swap space in bytes.
  858. `used`::
  859. (<<byte-units,byte value>>)
  860. Amount of used swap space.
  861. `used_in_bytes`::
  862. (integer)
  863. Amount of used swap space in bytes.
  864. =======
  865. `cgroup` (Linux only)::
  866. (object)
  867. Contains cgroup statistics for the node.
  868. +
  869. NOTE: For the cgroup stats to be visible, cgroups must be compiled into the
  870. kernel, the `cpu` and `cpuacct` cgroup subsystems must be configured and stats
  871. must be readable from `/sys/fs/cgroup/cpu` and `/sys/fs/cgroup/cpuacct`.
  872. +
  873. .Properties of `cgroup`
  874. [%collapsible%open]
  875. =======
  876. `cpuacct` (Linux only)::
  877. (object)
  878. Contains statistics about `cpuacct` control group for the node.
  879. +
  880. .Properties of `cpuacct`
  881. [%collapsible%open]
  882. ========
  883. `control_group` (Linux only)::
  884. (string)
  885. The `cpuacct` control group to which the {es} process belongs.
  886. `usage_nanos` (Linux only)::
  887. (integer)
  888. The total CPU time (in nanoseconds) consumed by all tasks in the same cgroup
  889. as the {es} process.
  890. ========
  891. `cpu` (Linux only)::
  892. (object)
  893. Contains statistics about `cpu` control group for the node.
  894. +
  895. .Properties of `cpu`
  896. [%collapsible%open]
  897. ========
  898. `control_group` (Linux only)::
  899. (string)
  900. The `cpu` control group to which the {es} process belongs.
  901. `cfs_period_micros` (Linux only)::
  902. (integer)
  903. The period of time (in microseconds) for how regularly all tasks in the same
  904. cgroup as the {es} process should have their access to CPU resources
  905. reallocated.
  906. `cfs_quota_micros` (Linux only)::
  907. (integer)
  908. The total amount of time (in microseconds) for which all tasks in
  909. the same cgroup as the {es} process can run during one period
  910. `cfs_period_micros`.
  911. `stat` (Linux only)::
  912. (object)
  913. Contains CPU statistics for the node.
  914. +
  915. .Properties of `stat`
  916. [%collapsible%open]
  917. =========
  918. `number_of_elapsed_periods` (Linux only)::
  919. (integer)
  920. The number of reporting periods (as specified by
  921. `cfs_period_micros`) that have elapsed.
  922. `number_of_times_throttled` (Linux only)::
  923. (integer)
  924. The number of times all tasks in the same cgroup as the {es} process have
  925. been throttled.
  926. `time_throttled_nanos` (Linux only)::
  927. (integer)
  928. The total amount of time (in nanoseconds) for which all tasks in the same
  929. cgroup as the {es} process have been throttled.
  930. =========
  931. ========
  932. `memory` (Linux only)::
  933. (object)
  934. Contains statistics about the `memory` control group for the node.
  935. +
  936. .Properties of `memory`
  937. [%collapsible%open]
  938. ========
  939. `control_group` (Linux only)::
  940. (string)
  941. The `memory` control group to which the {es} process belongs.
  942. `limit_in_bytes` (Linux only)::
  943. (string)
  944. The maximum amount of user memory (including file cache) allowed for all
  945. tasks in the same cgroup as the {es} process. This value can be too big to
  946. store in a `long`, so is returned as a string so that the value returned can
  947. exactly match what the underlying operating system interface returns. Any
  948. value that is too large to parse into a `long` almost certainly means no
  949. limit has been set for the cgroup.
  950. `usage_in_bytes` (Linux only)::
  951. (string)
  952. The total current memory usage by processes in the cgroup (in bytes) by all
  953. tasks in the same cgroup as the {es} process. This value is stored as a
  954. string for consistency with `limit_in_bytes`.
  955. ========
  956. =======
  957. ======
  958. [[cluster-nodes-stats-api-response-body-process]]
  959. `process`::
  960. (object)
  961. Contains process statistics for the node.
  962. +
  963. .Properties of `process`
  964. [%collapsible%open]
  965. ======
  966. `timestamp`::
  967. (integer)
  968. Last time the statistics were refreshed. Recorded in milliseconds
  969. since the {wikipedia}/Unix_time[Unix Epoch].
  970. `open_file_descriptors`::
  971. (integer)
  972. Number of opened file descriptors associated with the current or
  973. `-1` if not supported.
  974. `max_file_descriptors`::
  975. (integer)
  976. Maximum number of file descriptors allowed on the system, or `-1` if not
  977. supported.
  978. `cpu`::
  979. (object)
  980. Contains CPU statistics for the node.
  981. +
  982. .Properties of `cpu`
  983. [%collapsible%open]
  984. =======
  985. `percent`::
  986. (integer)
  987. CPU usage in percent, or `-1` if not known at the time the stats are
  988. computed.
  989. `total`::
  990. (<<time-units,time value>>)
  991. CPU time used by the process on which the Java virtual machine is running.
  992. `total_in_millis`::
  993. (integer)
  994. CPU time (in milliseconds) used by the process on which the Java virtual
  995. machine is running, or `-1` if not supported.
  996. =======
  997. `mem`::
  998. (object)
  999. Contains virtual memory statistics for the node.
  1000. +
  1001. .Properties of `mem`
  1002. [%collapsible%open]
  1003. =======
  1004. `total_virtual`::
  1005. (<<byte-units,byte value>>)
  1006. Size of virtual memory that is guaranteed to be available to the
  1007. running process.
  1008. `total_virtual_in_bytes`::
  1009. (integer)
  1010. Size in bytes of virtual memory that is guaranteed to be available to the
  1011. running process.
  1012. =======
  1013. ======
  1014. [[cluster-nodes-stats-api-response-body-jvm]]
  1015. `jvm`::
  1016. (object)
  1017. Contains Java Virtual Machine (JVM) statistics for the node.
  1018. +
  1019. .Properties of `jvm`
  1020. [%collapsible%open]
  1021. ======
  1022. `timestamp`::
  1023. (integer)
  1024. Last time JVM statistics were refreshed.
  1025. `uptime`::
  1026. (<<time-units,time value>>)
  1027. JVM uptime.
  1028. `uptime_in_millis`::
  1029. (integer)
  1030. JVM uptime in milliseconds.
  1031. `mem`::
  1032. (object)
  1033. Contains JVM memory usage statistics for the node.
  1034. +
  1035. .Properties of `mem`
  1036. [%collapsible%open]
  1037. =======
  1038. `heap_used`::
  1039. (<<byte-units,byte value>>)
  1040. Memory currently in use by the heap.
  1041. `heap_used_in_bytes`::
  1042. (integer)
  1043. Memory, in bytes, currently in use by the heap.
  1044. `heap_used_percent`::
  1045. (integer)
  1046. Percentage of memory currently in use by the heap.
  1047. `heap_committed`::
  1048. (<<byte-units,byte value>>)
  1049. Amount of memory available for use by the heap.
  1050. `heap_committed_in_bytes`::
  1051. (integer)
  1052. Amount of memory, in bytes, available for use by the heap.
  1053. `heap_max`::
  1054. (<<byte-units,byte value>>)
  1055. Maximum amount of memory available for use by the heap.
  1056. `heap_max_in_bytes`::
  1057. (integer)
  1058. Maximum amount of memory, in bytes, available for use by the heap.
  1059. `non_heap_used`::
  1060. (<<byte-units,byte value>>)
  1061. Non-heap memory used.
  1062. `non_heap_used_in_bytes`::
  1063. (integer)
  1064. Non-heap memory used, in bytes.
  1065. `non_heap_committed`::
  1066. (<<byte-units,byte value>>)
  1067. Amount of non-heap memory available.
  1068. `non_heap_committed_in_bytes`::
  1069. (integer)
  1070. Amount of non-heap memory available, in bytes.
  1071. `pools`::
  1072. (object)
  1073. Contains statistics about heap memory usage for the node.
  1074. +
  1075. .Properties of `pools`
  1076. [%collapsible%open]
  1077. ========
  1078. `young`::
  1079. (object)
  1080. Contains statistics about memory usage by the young generation heap for the
  1081. node.
  1082. +
  1083. .Properties of `young`
  1084. [%collapsible%open]
  1085. =========
  1086. `used`::
  1087. (<<byte-units,byte value>>)
  1088. Memory used by the young generation heap.
  1089. `used_in_bytes`::
  1090. (integer)
  1091. Memory, in bytes, used by the young generation heap.
  1092. `max`::
  1093. (<<byte-units,byte value>>)
  1094. Maximum amount of memory available for use by the young generation heap.
  1095. `max_in_bytes`::
  1096. (integer)
  1097. Maximum amount of memory, in bytes, available for use by the young generation
  1098. heap.
  1099. `peak_used`::
  1100. (<<byte-units,byte value>>)
  1101. Largest amount of memory historically used by the young generation heap.
  1102. `peak_used_in_bytes`::
  1103. (integer)
  1104. Largest amount of memory, in bytes, historically used by the young generation
  1105. heap.
  1106. `peak_max`::
  1107. (<<byte-units,byte value>>)
  1108. Largest amount of memory historically used by the young generation heap.
  1109. `peak_max_in_bytes`::
  1110. (integer)
  1111. Largest amount of memory, in bytes, historically used by the young generation
  1112. heap.
  1113. =========
  1114. `survivor`::
  1115. (object)
  1116. Contains statistics about memory usage by the survivor space for the node.
  1117. +
  1118. .Properties of `survivor`
  1119. [%collapsible%open]
  1120. =========
  1121. `used`::
  1122. (<<byte-units,byte value>>)
  1123. Memory used by the survivor space.
  1124. `used_in_bytes`::
  1125. (integer)
  1126. Memory, in bytes, used by the survivor space.
  1127. `max`::
  1128. (<<byte-units,byte value>>)
  1129. Maximum amount of memory available for use by the survivor space.
  1130. `max_in_bytes`::
  1131. (integer)
  1132. Maximum amount of memory, in bytes, available for use by the survivor space.
  1133. `peak_used`::
  1134. (<<byte-units,byte value>>)
  1135. Largest amount of memory historically used by the survivor space.
  1136. `peak_used_in_bytes`::
  1137. (integer)
  1138. Largest amount of memory, in bytes, historically used by the survivor space.
  1139. `peak_max`::
  1140. (<<byte-units,byte value>>)
  1141. Largest amount of memory historically used by the survivor space.
  1142. `peak_max_in_bytes`::
  1143. (integer)
  1144. Largest amount of memory, in bytes, historically used by the survivor space.
  1145. =========
  1146. `old`::
  1147. (object)
  1148. Contains statistics about memory usage by the old generation heap for the node.
  1149. +
  1150. .Properties of `old`
  1151. [%collapsible%open]
  1152. =========
  1153. `used`::
  1154. (<<byte-units,byte value>>)
  1155. Memory used by the old generation heap.
  1156. `used_in_bytes`::
  1157. (integer)
  1158. Memory, in bytes, used by the old generation heap.
  1159. `max`::
  1160. (<<byte-units,byte value>>)
  1161. Maximum amount of memory available for use by the old generation heap.
  1162. `max_in_bytes`::
  1163. (integer)
  1164. Maximum amount of memory, in bytes, available for use by the old generation
  1165. heap.
  1166. `peak_used`::
  1167. (<<byte-units,byte value>>)
  1168. Largest amount of memory historically used by the old generation heap.
  1169. `peak_used_in_bytes`::
  1170. (integer)
  1171. Largest amount of memory, in bytes, historically used by the old generation
  1172. heap.
  1173. `peak_max`::
  1174. (<<byte-units,byte value>>)
  1175. Highest memory limit historically available for use by the old generation heap.
  1176. `peak_max_in_bytes`::
  1177. (integer)
  1178. Highest memory limit, in bytes, historically available for use by the old
  1179. generation heap.
  1180. =========
  1181. ========
  1182. =======
  1183. `threads`::
  1184. (object)
  1185. Contains statistics about JVM thread usage for the node.
  1186. +
  1187. .Properties of `threads`
  1188. [%collapsible%open]
  1189. =======
  1190. `count`::
  1191. (integer)
  1192. Number of active threads in use by JVM.
  1193. `peak_count`::
  1194. (integer)
  1195. Highest number of threads used by JVM.
  1196. =======
  1197. `gc`::
  1198. (object)
  1199. Contains statistics about JVM garbage collectors for the node.
  1200. +
  1201. .Properties of `gc`
  1202. [%collapsible%open]
  1203. =======
  1204. `collectors`::
  1205. (object)
  1206. Contains statistics about JVM garbage collectors for the node.
  1207. +
  1208. .Properties of `collectors`
  1209. [%collapsible%open]
  1210. ========
  1211. `young`::
  1212. (object)
  1213. Contains statistics about JVM garbage collectors that collect young generation
  1214. objects for the node.
  1215. +
  1216. .Properties of `young`
  1217. [%collapsible%open]
  1218. =========
  1219. `collection_count`::
  1220. (integer)
  1221. Number of JVM garbage collectors that collect young generation objects.
  1222. `collection_time`::
  1223. (<<time-units,time value>>)
  1224. Total time spent by JVM collecting young generation objects.
  1225. `collection_time_in_millis`::
  1226. (integer)
  1227. Total time in milliseconds spent by JVM collecting young generation objects.
  1228. =========
  1229. `old`::
  1230. (object)
  1231. Contains statistics about JVM garbage collectors that collect old generation
  1232. objects for the node.
  1233. +
  1234. .Properties of `old`
  1235. [%collapsible%open]
  1236. =========
  1237. `collection_count`::
  1238. (integer)
  1239. Number of JVM garbage collectors that collect old generation objects.
  1240. `collection_time`::
  1241. (<<time-units,time value>>)
  1242. Total time spent by JVM collecting old generation objects.
  1243. `collection_time_in_millis`::
  1244. (integer)
  1245. Total time in milliseconds spent by JVM collecting old generation objects.
  1246. =========
  1247. ========
  1248. =======
  1249. `buffer_pools`::
  1250. (object)
  1251. Contains statistics about JVM buffer pools for the node.
  1252. +
  1253. .Properties of `buffer_pools`
  1254. [%collapsible%open]
  1255. =======
  1256. `mapped`::
  1257. (object)
  1258. Contains statistics about mapped JVM buffer pools for the node.
  1259. +
  1260. .Properties of `mapped`
  1261. [%collapsible%open]
  1262. ========
  1263. `count`::
  1264. (integer)
  1265. Number of mapped buffer pools.
  1266. `used`::
  1267. (<<byte-units,byte value>>)
  1268. Size of mapped buffer pools.
  1269. `used_in_bytes`::
  1270. (integer)
  1271. Size, in bytes, of mapped buffer pools.
  1272. `total_capacity`::
  1273. (<<byte-units,byte value>>)
  1274. Total capacity of mapped buffer pools.
  1275. `total_capacity_in_bytes`::
  1276. (integer)
  1277. Total capacity, in bytes, of mapped buffer pools.
  1278. ========
  1279. `direct`::
  1280. (object)
  1281. Contains statistics about direct JVM buffer pools for the node.
  1282. +
  1283. .Properties of `direct`
  1284. [%collapsible%open]
  1285. ========
  1286. `count`::
  1287. (integer)
  1288. Number of direct buffer pools.
  1289. `used`::
  1290. (<<byte-units,byte value>>)
  1291. Size of direct buffer pools.
  1292. `used_in_bytes`::
  1293. (integer)
  1294. Size, in bytes, of direct buffer pools.
  1295. `total_capacity`::
  1296. (<<byte-units,byte value>>)
  1297. Total capacity of direct buffer pools.
  1298. `total_capacity_in_bytes`::
  1299. (integer)
  1300. Total capacity, in bytes, of direct buffer pools.
  1301. ========
  1302. =======
  1303. `classes`::
  1304. (object)
  1305. Contains statistics about classes loaded by JVM for the node.
  1306. +
  1307. .Properties of `classes`
  1308. [%collapsible%open]
  1309. =======
  1310. `current_loaded_count`::
  1311. (integer)
  1312. Number of classes currently loaded by JVM.
  1313. `total_loaded_count`::
  1314. (integer)
  1315. Total number of classes loaded since the JVM started.
  1316. `total_unloaded_count`::
  1317. (integer)
  1318. Total number of classes unloaded since the JVM started.
  1319. =======
  1320. ======
  1321. [[cluster-nodes-stats-api-response-body-threadpool]]
  1322. `thread_pool`::
  1323. (object)
  1324. Contains thread pool statistics for the node
  1325. +
  1326. .Properties of `thread_pool`
  1327. [%collapsible%open]
  1328. ======
  1329. `<thread_pool_name>`::
  1330. (object)
  1331. Contains statistics about the thread pool for the node.
  1332. +
  1333. .Properties of `<thread_pool_name>`
  1334. [%collapsible%open]
  1335. =======
  1336. `threads`::
  1337. (integer)
  1338. Number of threads in the thread pool.
  1339. `queue`::
  1340. (integer)
  1341. Number of tasks in queue for the thread pool.
  1342. `active`::
  1343. (integer)
  1344. Number of active threads in the thread pool.
  1345. `rejected`::
  1346. (integer)
  1347. Number of tasks rejected by the thread pool executor.
  1348. `largest`::
  1349. (integer)
  1350. Highest number of active threads in the thread pool.
  1351. `completed`::
  1352. (integer)
  1353. Number of tasks completed by the thread pool executor.
  1354. =======
  1355. ======
  1356. [[cluster-nodes-stats-api-response-body-fs]]
  1357. `fs`::
  1358. (object)
  1359. Contains file store statistics for the node.
  1360. +
  1361. .Properties of `fs`
  1362. [%collapsible%open]
  1363. ======
  1364. `timestamp`::
  1365. (integer)
  1366. Last time the file stores statistics were refreshed. Recorded in
  1367. milliseconds since the {wikipedia}/Unix_time[Unix Epoch].
  1368. `total`::
  1369. (object)
  1370. Contains statistics for all file stores of the node.
  1371. +
  1372. .Properties of `total`
  1373. [%collapsible%open]
  1374. =======
  1375. `total`::
  1376. (<<byte-units,byte value>>)
  1377. Total size of all file stores.
  1378. `total_in_bytes`::
  1379. (integer)
  1380. Total size (in bytes) of all file stores.
  1381. `free`::
  1382. (<<byte-units,byte value>>)
  1383. Total unallocated disk space in all file stores.
  1384. `free_in_bytes`::
  1385. (integer)
  1386. Total number of unallocated bytes in all file stores.
  1387. `available`::
  1388. (<<byte-units,byte value>>)
  1389. Total disk space available to this Java virtual machine on all file
  1390. stores. Depending on OS or process level restrictions, this might appear
  1391. less than `free`. This is the actual amount of free disk
  1392. space the {es} node can utilise.
  1393. `available_in_bytes`::
  1394. (integer)
  1395. Total number of bytes available to this Java virtual machine on all file
  1396. stores. Depending on OS or process level restrictions, this might appear
  1397. less than `free_in_bytes`. This is the actual amount of free disk
  1398. space the {es} node can utilise.
  1399. =======
  1400. [[cluster-nodes-stats-fs-data]]
  1401. `data`::
  1402. (array of objects)
  1403. List of all file stores.
  1404. +
  1405. .Properties of `data`
  1406. [%collapsible%open]
  1407. =======
  1408. `path`::
  1409. (string)
  1410. Path to the file store.
  1411. `mount`::
  1412. (string)
  1413. Mount point of the file store (ex: /dev/sda2).
  1414. `type`::
  1415. (string)
  1416. Type of the file store (ex: ext4).
  1417. `total`::
  1418. (<<byte-units,byte value>>)
  1419. Total size of the file store.
  1420. `total_in_bytes`::
  1421. (integer)
  1422. Total size (in bytes) of the file store.
  1423. `free`::
  1424. (<<byte-units,byte value>>)
  1425. Total amount of unallocated disk space in the file store.
  1426. `free_in_bytes`::
  1427. (integer)
  1428. Total number of unallocated bytes in the file store.
  1429. `available`::
  1430. (<<byte-units,byte value>>)
  1431. Total amount of disk space available to this Java virtual machine on this file
  1432. store.
  1433. `available_in_bytes`::
  1434. (integer)
  1435. Total number of bytes available to this Java virtual machine on this file
  1436. store.
  1437. =======
  1438. `io_stats` (Linux only)::
  1439. (objects)
  1440. Contains I/O statistics for the node.
  1441. +
  1442. .Properties of `io_stats`
  1443. [%collapsible%open]
  1444. =======
  1445. `devices` (Linux only)::
  1446. (array)
  1447. Array of disk metrics for each device that is backing an {es} data path.
  1448. These disk metrics are probed periodically and averages between the last
  1449. probe and the current probe are computed.
  1450. +
  1451. .Properties of `devices`
  1452. [%collapsible%open]
  1453. ========
  1454. `device_name` (Linux only)::
  1455. (string)
  1456. The Linux device name.
  1457. `operations` (Linux only)::
  1458. (integer)
  1459. The total number of read and write operations for the device completed since
  1460. starting {es}.
  1461. `read_operations` (Linux only)::
  1462. (integer)
  1463. The total number of read operations for the device completed since starting
  1464. {es}.
  1465. `write_operations` (Linux only)::
  1466. (integer)
  1467. The total number of write operations for the device completed since starting
  1468. {es}.
  1469. `read_kilobytes` (Linux only)::
  1470. (integer)
  1471. The total number of kilobytes read for the device since starting {es}.
  1472. `write_kilobytes` (Linux only)::
  1473. (integer)
  1474. The total number of kilobytes written for the device since starting {es}.
  1475. ========
  1476. `operations` (Linux only)::
  1477. (integer)
  1478. The total number of read and write operations across all devices used by
  1479. {es} completed since starting {es}.
  1480. `read_operations` (Linux only)::
  1481. (integer)
  1482. The total number of read operations for across all devices used by {es}
  1483. completed since starting {es}.
  1484. `write_operations` (Linux only)::
  1485. (integer)
  1486. The total number of write operations across all devices used by {es}
  1487. completed since starting {es}.
  1488. `read_kilobytes` (Linux only)::
  1489. (integer)
  1490. The total number of kilobytes read across all devices used by {es} since
  1491. starting {es}.
  1492. `write_kilobytes` (Linux only)::
  1493. (integer)
  1494. The total number of kilobytes written across all devices used by {es} since
  1495. starting {es}.
  1496. =======
  1497. ======
  1498. [[cluster-nodes-stats-api-response-body-transport]]
  1499. `transport`::
  1500. (object)
  1501. Contains transport statistics for the node.
  1502. +
  1503. .Properties of `transport`
  1504. [%collapsible%open]
  1505. ======
  1506. `server_open`::
  1507. (integer)
  1508. Current number of inbound TCP connections used for internal communication between nodes.
  1509. `total_outbound_connections`::
  1510. (integer)
  1511. The cumulative number of outbound transport connections that this node has
  1512. opened since it started. Each transport connection may comprise multiple TCP
  1513. connections but is only counted once in this statistic. Transport connections
  1514. are typically <<long-lived-connections,long-lived>> so this statistic should
  1515. remain constant in a stable cluster.
  1516. `rx_count`::
  1517. (integer)
  1518. Total number of RX (receive) packets received by the node during internal
  1519. cluster communication.
  1520. `rx_size`::
  1521. (<<byte-units,byte value>>)
  1522. Size of RX packets received by the node during internal cluster communication.
  1523. `rx_size_in_bytes`::
  1524. (integer)
  1525. Size, in bytes, of RX packets received by the node during internal cluster
  1526. communication.
  1527. `tx_count`::
  1528. (integer)
  1529. Total number of TX (transmit) packets sent by the node during internal cluster
  1530. communication.
  1531. `tx_size`::
  1532. (<<byte-units,byte value>>)
  1533. Size of TX packets sent by the node during internal cluster communication.
  1534. `tx_size_in_bytes`::
  1535. (integer)
  1536. Size, in bytes, of TX packets sent by the node during internal cluster
  1537. communication.
  1538. ======
  1539. [[cluster-nodes-stats-api-response-body-http]]
  1540. `http`::
  1541. (object)
  1542. Contains http statistics for the node.
  1543. +
  1544. .Properties of `http`
  1545. [%collapsible%open]
  1546. ======
  1547. `current_open`::
  1548. (integer)
  1549. Current number of open HTTP connections for the node.
  1550. `total_opened`::
  1551. (integer)
  1552. Total number of HTTP connections opened for the node.
  1553. ======
  1554. [[cluster-nodes-stats-api-response-body-breakers]]
  1555. `breakers`::
  1556. (object)
  1557. Contains circuit breaker statistics for the node.
  1558. +
  1559. .Properties of `breakers`
  1560. [%collapsible%open]
  1561. ======
  1562. `<circuit_breaker_name>`::
  1563. (object)
  1564. Contains statistics for the circuit breaker.
  1565. +
  1566. .Properties of `<circuit_breaker_name>`
  1567. [%collapsible%open]
  1568. =======
  1569. `limit_size_in_bytes`::
  1570. (integer)
  1571. Memory limit, in bytes, for the circuit breaker.
  1572. `limit_size`::
  1573. (<<byte-units,byte value>>)
  1574. Memory limit for the circuit breaker.
  1575. `estimated_size_in_bytes`::
  1576. (integer)
  1577. Estimated memory used, in bytes, for the operation.
  1578. `estimated_size`::
  1579. (<<byte-units,byte value>>)
  1580. Estimated memory used for the operation.
  1581. `overhead`::
  1582. (float)
  1583. A constant that all estimates for the circuit breaker are multiplied with to
  1584. calculate a final estimate.
  1585. `tripped`::
  1586. (integer)
  1587. Total number of times the circuit breaker has been triggered and prevented an
  1588. out of memory error.
  1589. =======
  1590. ======
  1591. [[cluster-nodes-stats-api-response-body-script]]
  1592. `script`::
  1593. (object)
  1594. Contains script statistics for the node.
  1595. +
  1596. .Properties of `script`
  1597. [%collapsible%open]
  1598. ======
  1599. `compilations`::
  1600. (integer)
  1601. Total number of inline script compilations performed by the node.
  1602. `cache_evictions`::
  1603. (integer)
  1604. Total number of times the script cache has evicted old data.
  1605. `compilation_limit_triggered`::
  1606. (integer)
  1607. Total number of times the <<script-compilation-circuit-breaker,script
  1608. compilation>> circuit breaker has limited inline script compilations.
  1609. ======
  1610. [[cluster-nodes-stats-api-response-body-discovery]]
  1611. `discovery`::
  1612. (object)
  1613. Contains node discovery statistics for the node.
  1614. +
  1615. .Properties of `discovery`
  1616. [%collapsible%open]
  1617. ======
  1618. `cluster_state_queue`::
  1619. (object)
  1620. Contains statistics for the cluster state queue of the node.
  1621. +
  1622. .Properties of `cluster_state_queue`
  1623. [%collapsible%open]
  1624. =======
  1625. `total`::
  1626. (integer)
  1627. Total number of cluster states in queue.
  1628. `pending`::
  1629. (integer)
  1630. Number of pending cluster states in queue.
  1631. `committed`::
  1632. (integer)
  1633. Number of committed cluster states in queue.
  1634. =======
  1635. `published_cluster_states`::
  1636. (object)
  1637. Contains statistics for the published cluster states of the node.
  1638. +
  1639. .Properties of `published_cluster_states`
  1640. [%collapsible%open]
  1641. =======
  1642. `full_states`::
  1643. (integer)
  1644. Number of published cluster states.
  1645. `incompatible_diffs`::
  1646. (integer)
  1647. Number of incompatible differences between published cluster states.
  1648. `compatible_diffs`::
  1649. (integer)
  1650. Number of compatible differences between published cluster states.
  1651. =======
  1652. ======
  1653. [[cluster-nodes-stats-api-response-body-ingest]]
  1654. `ingest`::
  1655. (object)
  1656. Contains ingest statistics for the node.
  1657. +
  1658. .Properties of `ingest`
  1659. [%collapsible%open]
  1660. ======
  1661. `total`::
  1662. (object)
  1663. Contains statistics about ingest operations for the node.
  1664. +
  1665. .Properties of `total`
  1666. [%collapsible%open]
  1667. =======
  1668. `count`::
  1669. (integer)
  1670. Total number of documents ingested during the lifetime of this node.
  1671. `time`::
  1672. (<<time-units,time value>>)
  1673. Total time spent preprocessing ingest documents during the lifetime of this
  1674. node.
  1675. `time_in_millis`::
  1676. (integer)
  1677. Total time, in milliseconds, spent preprocessing ingest documents during the
  1678. lifetime of this node.
  1679. `current`::
  1680. (integer)
  1681. Total number of documents currently being ingested.
  1682. `failed`::
  1683. (integer)
  1684. Total number of failed ingest operations during the lifetime of this node.
  1685. =======
  1686. `pipelines`::
  1687. (object)
  1688. Contains statistics about ingest pipelines for the node.
  1689. +
  1690. .Properties of `pipelines`
  1691. [%collapsible%open]
  1692. =======
  1693. `<pipeline_id>`::
  1694. (object)
  1695. Contains statistics about the ingest pipeline.
  1696. +
  1697. .Properties of `<pipeline_id>`
  1698. [%collapsible%open]
  1699. ========
  1700. `count`::
  1701. (integer)
  1702. Number of documents preprocessed by the ingest pipeline.
  1703. `time`::
  1704. (<<time-units,time value>>)
  1705. Total time spent preprocessing documents in the ingest pipeline.
  1706. `time_in_millis`::
  1707. (integer)
  1708. Total time, in milliseconds, spent preprocessing documents in the ingest
  1709. pipeline.
  1710. `failed`::
  1711. (integer)
  1712. Total number of failed operations for the ingest pipeline.
  1713. `processors`::
  1714. (array of objects)
  1715. Contains statistics for the ingest processors for the ingest pipeline.
  1716. +
  1717. .Properties of `processors`
  1718. [%collapsible%open]
  1719. =========
  1720. `<processor>`::
  1721. (object)
  1722. Contains statistics for the ingest processor.
  1723. +
  1724. .Properties of `<processor>`
  1725. [%collapsible%open]
  1726. ==========
  1727. `count`::
  1728. (integer)
  1729. Number of documents transformed by the processor.
  1730. `time`::
  1731. (<<time-units,time value>>)
  1732. Time spent by the processor transforming documents.
  1733. `time_in_millis`::
  1734. (integer)
  1735. Time, in milliseconds, spent by the processor transforming documents.
  1736. `current`::
  1737. (integer)
  1738. Number of documents currently being transformed by the processor.
  1739. `failed`::
  1740. (integer)
  1741. Number of failed operations for the processor.
  1742. ==========
  1743. =========
  1744. ========
  1745. =======
  1746. ======
  1747. [[cluster-nodes-stats-api-response-body-indexing-pressure]]
  1748. `indexing_pressure`::
  1749. (object)
  1750. Contains <<index-modules-indexing-pressure,indexing pressure>> statistics for the node.
  1751. +
  1752. .Properties of `indexing_pressure`
  1753. [%collapsible%open]
  1754. ======
  1755. `memory`::
  1756. (object)
  1757. Contains statistics for memory consumption from indexing load.
  1758. +
  1759. .Properties of `<memory>`
  1760. [%collapsible%open]
  1761. =======
  1762. `current`::
  1763. (object)
  1764. Contains statistics for current indexing load.
  1765. +
  1766. .Properties of `<current>`
  1767. [%collapsible%open]
  1768. ========
  1769. `combined_coordinating_and_primary`::
  1770. (<<byte-units,byte value>>)
  1771. Memory consumed by indexing requests in the coordinating or primary stage. This
  1772. value is not the sum of coordinating and primary as a node can reuse the
  1773. coordinating memory if the primary stage is executed locally.
  1774. `combined_coordinating_and_primary_in_bytes`::
  1775. (integer)
  1776. Memory consumed, in bytes, by indexing requests in the coordinating or primary
  1777. stage. This value is not the sum of coordinating and primary as a node can
  1778. reuse the coordinating memory if the primary stage is executed locally.
  1779. `coordinating`::
  1780. (<<byte-units,byte value>>)
  1781. Memory consumed by indexing requests in the coordinating stage.
  1782. `coordinating_in_bytes`::
  1783. (integer)
  1784. Memory consumed, in bytes, by indexing requests in the coordinating stage.
  1785. `primary`::
  1786. (<<byte-units,byte value>>)
  1787. Memory consumed by indexing requests in the primary stage.
  1788. `primary_in_bytes`::
  1789. (integer)
  1790. Memory consumed, in bytes, by indexing requests in the primary stage.
  1791. `replica`::
  1792. (<<byte-units,byte value>>)
  1793. Memory consumed by indexing requests in the replica stage.
  1794. `replica_in_bytes`::
  1795. (integer)
  1796. Memory consumed, in bytes, by indexing requests in the replica stage.
  1797. `all`::
  1798. (<<byte-units,byte value>>)
  1799. Memory consumed by indexing requests in the coordinating, primary, or replica stage.
  1800. `all_in_bytes`::
  1801. (integer)
  1802. Memory consumed, in bytes, by indexing requests in the coordinating, primary,
  1803. or replica stage.
  1804. ========
  1805. `total`::
  1806. (object)
  1807. Contains statistics for the cumulative indexing load since the node started.
  1808. +
  1809. .Properties of `<total>`
  1810. [%collapsible%open]
  1811. ========
  1812. `combined_coordinating_and_primary`::
  1813. (<<byte-units,byte value>>)
  1814. Memory consumed by indexing requests in the coordinating or primary stage. This
  1815. value is not the sum of coordinating and primary as a node can reuse the
  1816. coordinating memory if the primary stage is executed locally.
  1817. `combined_coordinating_and_primary_in_bytes`::
  1818. (integer)
  1819. Memory consumed, in bytes, by indexing requests in the coordinating or primary
  1820. stage. This value is not the sum of coordinating and primary as a node can
  1821. reuse the coordinating memory if the primary stage is executed locally.
  1822. `coordinating`::
  1823. (<<byte-units,byte value>>)
  1824. Memory consumed by indexing requests in the coordinating stage.
  1825. `coordinating_in_bytes`::
  1826. (integer)
  1827. Memory consumed, in bytes, by indexing requests in the coordinating stage.
  1828. `primary`::
  1829. (<<byte-units,byte value>>)
  1830. Memory consumed by indexing requests in the primary stage.
  1831. `primary_in_bytes`::
  1832. (integer)
  1833. Memory consumed, in bytes, by indexing requests in the primary stage.
  1834. `replica`::
  1835. (<<byte-units,byte value>>)
  1836. Memory consumed by indexing requests in the replica stage.
  1837. `replica_in_bytes`::
  1838. (integer)
  1839. Memory consumed, in bytes, by indexing requests in the replica stage.
  1840. `all`::
  1841. (<<byte-units,byte value>>)
  1842. Memory consumed by indexing requests in the coordinating, primary, or replica stage.
  1843. `all_in_bytes`::
  1844. (integer)
  1845. Memory consumed, in bytes, by indexing requests in the coordinating, primary,
  1846. or replica stage.
  1847. `coordinating_rejections`::
  1848. (integer)
  1849. Number of indexing requests rejected in the coordinating stage.
  1850. `primary_rejections`::
  1851. (integer)
  1852. Number of indexing requests rejected in the primary stage.
  1853. `replica_rejections`::
  1854. (integer)
  1855. Number of indexing requests rejected in the replica stage.
  1856. ========
  1857. `limit`::
  1858. (<<byte-units,byte value>>)
  1859. Configured memory limit for the indexing requests. Replica requests have an
  1860. automatic limit that is 1.5x this value.
  1861. `limit_in_bytes`::
  1862. (integer)
  1863. Configured memory limit, in bytes, for the indexing requests. Replica requests
  1864. have an automatic limit that is 1.5x this value.
  1865. =======
  1866. ======
  1867. [[cluster-nodes-stats-api-response-body-adaptive-selection]]
  1868. `adaptive_selection`::
  1869. (object)
  1870. Contains adaptive selection statistics for the node.
  1871. +
  1872. .Properties of `adaptive_selection`
  1873. [%collapsible%open]
  1874. ======
  1875. `outgoing_searches`::
  1876. (integer)
  1877. The number of outstanding search requests from the node these stats are for
  1878. to the keyed node.
  1879. `avg_queue_size`::
  1880. (integer)
  1881. The exponentially weighted moving average queue size of search requests on
  1882. the keyed node.
  1883. `avg_service_time`::
  1884. (<<time-units,time value>>)
  1885. The exponentially weighted moving average service time of search requests on
  1886. the keyed node.
  1887. `avg_service_time_ns`::
  1888. (integer)
  1889. The exponentially weighted moving average service time, in nanoseconds, of
  1890. search requests on the keyed node.
  1891. `avg_response_time`::
  1892. (<<time-units,time value>>)
  1893. The exponentially weighted moving average response time of search requests
  1894. on the keyed node.
  1895. `avg_response_time_ns`::
  1896. (integer)
  1897. The exponentially weighted moving average response time, in nanoseconds, of
  1898. search requests on the keyed node.
  1899. `rank`::
  1900. (string)
  1901. The rank of this node; used for shard selection when routing search
  1902. requests.
  1903. ======
  1904. =====
  1905. ====
  1906. [[cluster-nodes-stats-api-example]]
  1907. ==== {api-examples-title}
  1908. [source,console]
  1909. --------------------------------------------------
  1910. # return just indices
  1911. GET /_nodes/stats/indices
  1912. # return just os and process
  1913. GET /_nodes/stats/os,process
  1914. # return just process for node with IP address 10.0.0.1
  1915. GET /_nodes/10.0.0.1/stats/process
  1916. --------------------------------------------------
  1917. All stats can be explicitly requested via `/_nodes/stats/_all` or
  1918. `/_nodes/stats?metric=_all`.
  1919. You can get information about indices stats on `node`, `indices`, or `shards`
  1920. level.
  1921. [source,console]
  1922. --------------------------------------------------
  1923. # Fielddata summarized by node
  1924. GET /_nodes/stats/indices/fielddata?fields=field1,field2
  1925. # Fielddata summarized by node and index
  1926. GET /_nodes/stats/indices/fielddata?level=indices&fields=field1,field2
  1927. # Fielddata summarized by node, index, and shard
  1928. GET /_nodes/stats/indices/fielddata?level=shards&fields=field1,field2
  1929. # You can use wildcards for field names
  1930. GET /_nodes/stats/indices/fielddata?fields=field*
  1931. --------------------------------------------------
  1932. You can get statistics about search groups for searches executed
  1933. on this node.
  1934. [source,console]
  1935. --------------------------------------------------
  1936. # All groups with all stats
  1937. GET /_nodes/stats?groups=_all
  1938. # Some groups from just the indices stats
  1939. GET /_nodes/stats/indices?groups=foo,bar
  1940. --------------------------------------------------
  1941. [[cluster-nodes-stats-ingest-ex]]
  1942. ===== Retrieve ingest statistics only
  1943. To return only ingest-related node statistics, set the `<metric>` path
  1944. parameter to `ingest` and use the
  1945. <<common-options-response-filtering,`filter_path`>> query parameter.
  1946. [source,console]
  1947. --------------------------------------------------
  1948. GET /_nodes/stats/ingest?filter_path=nodes.*.ingest
  1949. --------------------------------------------------
  1950. You can use the `metric` and `filter_path` query parameters to get the same
  1951. response.
  1952. [source,console]
  1953. --------------------------------------------------
  1954. GET /_nodes/stats?metric=ingest&filter_path=nodes.*.ingest
  1955. --------------------------------------------------
  1956. To further refine the response, change the `filter_path` value.
  1957. For example, the following request only returns ingest pipeline statistics.
  1958. [source,console]
  1959. --------------------------------------------------
  1960. GET /_nodes/stats?metric=ingest&filter_path=nodes.*.ingest.pipelines
  1961. --------------------------------------------------