nodes-stats.asciidoc 52 KB

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