nodes-stats.asciidoc 29 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111
  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. `indices`::
  40. Indices stats about size, document count, indexing and deletion times,
  41. search times, field cache size, merges and flushes.
  42. `ingest`::
  43. Statistics about ingest preprocessing.
  44. `jvm`::
  45. JVM stats, memory pool information, garbage collection, buffer
  46. pools, number of loaded/unloaded classes.
  47. `os`::
  48. Operating system stats, load average, mem, swap.
  49. `process`::
  50. Process statistics, memory consumption, cpu usage, open
  51. file descriptors.
  52. `thread_pool`::
  53. Statistics about each thread pool, including current size, queue and
  54. rejected tasks.
  55. `transport`::
  56. Transport statistics about sent and received bytes in cluster
  57. communication.
  58. --
  59. `<index_metric>`::
  60. (Optional, string) Limit the information returned for `indices` metric to
  61. the specific index metrics. It can be used only if `indices` (or `all`)
  62. metric is specified. Supported metrics are:
  63. +
  64. --
  65. * `completion`
  66. * `docs`
  67. * `fielddata`
  68. * `flush`
  69. * `get`
  70. * `indexing`
  71. * `merge`
  72. * `query_cache`
  73. * `recovery`
  74. * `refresh`
  75. * `request_cache`
  76. * `search`
  77. * `segments`
  78. * `store`
  79. * `translog`
  80. * `warmer`
  81. --
  82. include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id]
  83. [[cluster-nodes-stats-api-query-params]]
  84. ==== {api-query-parms-title}
  85. include::{docdir}/rest-api/common-parms.asciidoc[tag=completion-fields]
  86. include::{docdir}/rest-api/common-parms.asciidoc[tag=fielddata-fields]
  87. include::{docdir}/rest-api/common-parms.asciidoc[tag=fields]
  88. include::{docdir}/rest-api/common-parms.asciidoc[tag=groups]
  89. include::{docdir}/rest-api/common-parms.asciidoc[tag=level]
  90. `types`::
  91. (Optional, string) A comma-separated list of document types for the
  92. `indexing` index metric.
  93. include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
  94. include::{docdir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes]
  95. [[cluster-nodes-stats-api-response-body]]
  96. ==== {api-response-body-title}
  97. [[cluster-nodes-stats-api-response-body-indices]]
  98. ===== `indices` section
  99. `indices.docs.count`::
  100. (integer)
  101. include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-count]
  102. `indices.docs.deleted`::
  103. (integer)
  104. include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-deleted]
  105. `indices.store.size_in_bytes`::
  106. (integer)
  107. Size, in bytes, of the store.
  108. `indices.indexing.index_total`::
  109. (integer)
  110. Total number of indexing operations.
  111. `indices.indexing.index_time_in_millis`::
  112. (integer)
  113. Total time in milliseconds
  114. spent performing indexing operations.
  115. `indices.indexing.index_current`::
  116. (integer)
  117. Number of indexing operations currently running.
  118. `indices.indexing.index_failed`::
  119. (integer)
  120. Number of failed indexing operations.
  121. `indices.indexing.delete_total`::
  122. (integer)
  123. Total number of deletion operations.
  124. `indices.indexing.delete_time_in_millis`::
  125. (integer)
  126. Time in milliseconds
  127. spent performing deletion operations.
  128. `indices.indexing.delete_current`::
  129. (integer)
  130. Number of deletion operations currently running.
  131. `indices.indexing.noop_update_total`::
  132. (integer)
  133. Total number of noop operations.
  134. `indices.indexing.is_throttled`::
  135. (boolean)
  136. Number of times
  137. operations were throttled.
  138. `indices.indexing.throttle_time_in_millis`::
  139. (integer)
  140. Total time in milliseconds
  141. spent throttling operations.
  142. `indices.get.total`::
  143. (integer)
  144. Total number of get operations.
  145. `indices.get.time_in_millis`::
  146. (integer)
  147. Time in milliseconds
  148. spent performing get operations.
  149. `indices.get.exists_total`::
  150. (integer)
  151. Total number of successful get operations.
  152. `indices.get.exists_time_in_millis`::
  153. (integer)
  154. Time in milliseconds
  155. spent performing successful get operations.
  156. `indices.get.missing_total`::
  157. (integer)
  158. Total number of failed get operations.
  159. `indices.get.missing_time_in_millis`::
  160. (integer)
  161. Time in milliseconds
  162. spent performing failed get operations.
  163. `indices.get.current`::
  164. (integer)
  165. Number of get operations currently running.
  166. `indices.search.open_context`::
  167. (integer)
  168. Number of open search contexts.
  169. `indices.search.query_total`::
  170. (integer)
  171. Total number of query operations.
  172. `indices.search.query_time_in_millis`::
  173. (integer)
  174. Time in milliseconds
  175. spent performing query operations.
  176. `indices.search.query_current`::
  177. (integer)
  178. Number of query operations currently running.
  179. `indices.search.fetch_total`::
  180. (integer)
  181. Total number of fetch operations.
  182. `indices.search.fetch_time_in_millis`::
  183. (integer)
  184. Time in milliseconds
  185. spent performing fetch operations.
  186. `indices.search.fetch_current`::
  187. (integer)
  188. Number of fetch operations currently running.
  189. `indices.search.scroll_total`::
  190. (integer)
  191. Total number of scroll operations.
  192. `indices.search.scroll_time_in_millis`::
  193. (integer)
  194. Time in milliseconds
  195. spent performing scroll operations.
  196. `indices.search.scroll_current`::
  197. (integer)
  198. Number of scroll operations currently running.
  199. `indices.search.suggest_total`::
  200. (integer)
  201. Total number of suggest operations.
  202. `indices.search.suggest_time_in_millis`::
  203. (integer)
  204. Time in milliseconds
  205. spent performing suggest operations.
  206. `indices.search.suggest_current`::
  207. (integer)
  208. Number of suggest operations currently running.
  209. `indices.merges.current`::
  210. (integer)
  211. Number of merge operations currently running.
  212. `indices.merges.current_docs`::
  213. (integer)
  214. Number of document merges currently running.
  215. `indices.merges.current_size_in_bytes`::
  216. (integer)
  217. Memory, in bytes, used performing current document merges.
  218. `indices.merges.total`::
  219. (integer)
  220. Total number of merge operations.
  221. `indices.merges.total_time_in_millis`::
  222. (integer)
  223. Total time in milliseconds
  224. spent performing merge operations.
  225. `indices.merges.total_docs`::
  226. (integer)
  227. Total number of merged documents.
  228. `indices.merges.total_size_in_bytes`::
  229. (integer)
  230. Total size of document merges in bytes.
  231. `indices.merges.total_stopped_time_in_millis`::
  232. (integer)
  233. Total time in milliseconds
  234. spent stopping merge operations.
  235. `indices.merges.total_throttled_time_in_millis`::
  236. (integer)
  237. Total time in milliseconds
  238. spent throttling merge operations.
  239. `indices.merges.total_auto_throttle_in_bytes`::
  240. (integer)
  241. Total time in milliseconds
  242. spent automatically throttling merge operations.
  243. `indices.refresh.total`::
  244. (integer)
  245. Total number of refresh operations.
  246. `indices.refresh.total_time_in_millis`::
  247. (integer)
  248. Total time in milliseconds
  249. spent performing refresh operations.
  250. `indices.refresh.external_total`::
  251. (integer)
  252. Total number of external refresh operations.
  253. `indices.refresh.external_total_time_in_millis`::
  254. (integer)
  255. Total time in milliseconds
  256. spent performing external operations.
  257. `indices.refresh.listeners`::
  258. (integer)
  259. Number of refresh listeners.
  260. `indices.flush.total`::
  261. (integer)
  262. Number of flush operations.
  263. `indices.flush.periodic`::
  264. (integer)
  265. Number of flush periodic operations.
  266. `indices.flush.total_time_in_millis`::
  267. (integer)
  268. Total time in milliseconds
  269. spent performing flush operations.
  270. `indices.warmer.current`::
  271. (integer)
  272. Number of active index warmers.
  273. `indices.warmer.total`::
  274. (integer)
  275. Total number of index warmers.
  276. `indices.warmer.total_time_in_millis`::
  277. (integer)
  278. Total time in milliseconds
  279. spent performing index warming operations.
  280. `indices.query_cache.memory_size_in_bytes`::
  281. (integer)
  282. Memory, in bytes, used for query cache.
  283. `indices.query_cache.total_count`::
  284. (integer)
  285. Total count of hits, misses, and cached queries
  286. in the query cache.
  287. `indices.query_cache.hit_count`::
  288. (integer)
  289. Number of query cache hits.
  290. `indices.query_cache.miss_count`::
  291. (integer)
  292. Number of query cache misses.
  293. `indices.query_cache.cache_size`::
  294. (integer)
  295. Size, in bytes, of the query cache.
  296. `indices.query_cache.cache_count`::
  297. (integer)
  298. Count of queries
  299. in the query cache.
  300. `indices.query_cache.evictions`::
  301. (integer)
  302. Number of query cache evictions.
  303. `indices.fielddata.memory_size_in_bytes`::
  304. (integer)
  305. Memory, in bytes, used for fielddata cache.
  306. `indices.fielddata.evictions`::
  307. (integer)
  308. Number of fielddata evictions.
  309. `indices.completion.size_in_bytes`::
  310. (integer)
  311. Memory, in bytes, used for completion.
  312. `indices.segments.count`::
  313. (integer)
  314. Number of segments.
  315. `indices.segments.memory_in_bytes`::
  316. (integer)
  317. Size, in bytes, of segments.
  318. `indices.segments.terms_memory_in_bytes`::
  319. (integer)
  320. Memory, in bytes, used of terms
  321. in segments.
  322. `indices.segments.stored_fields_memory_in_bytes`::
  323. (integer)
  324. Size, in bytes, of stored fields
  325. in segments.
  326. `indices.segments.term_vectors_memory_in_bytes`::
  327. (integer)
  328. Size, in bytes, of term vectors
  329. in segments.
  330. `indices.segments.norms_memory_in_bytes`::
  331. (integer)
  332. Size, in bytes, of normalization factors
  333. in segments.
  334. `indices.segments.points_memory_in_bytes`::
  335. (integer)
  336. Size, in bytes, of points
  337. in segments.
  338. `indices.segments.doc_values_memory_in_bytes`::
  339. (integer)
  340. Size, in bytes, of doc values
  341. in segments.
  342. `indices.segments.index_writer_memory_in_bytes`::
  343. (integer)
  344. Memory, in bytes, used by the index writer.
  345. `indices.segments.version_map_memory_in_bytes`::
  346. (integer)
  347. Memory, in bytes, used by the version map.
  348. `indices.segments.fixed_bit_set_memory_in_bytes`::
  349. (integer)
  350. Memory, in bytes,
  351. used by fixed bit sets
  352. for nested object field types
  353. and type filters
  354. for <<parent-join,join>> fields.
  355. `indices.segments.max_unsafe_auto_id_timestamp`::
  356. (integer)
  357. Timestamp of the
  358. most recent retry request.
  359. `indices.segments.file_sizes.size_in_bytes`::
  360. (integer)
  361. Size, in bytes,
  362. of the segment file.
  363. `indices.segments.file_sizes.description`::
  364. (string)
  365. Description of the segment file.
  366. `indices.translog.operations`::
  367. (integer)
  368. Number of transaction log operations.
  369. `indices.translog.size_in_bytes`::
  370. (integer)
  371. Size, in bytes, of the transaction log.
  372. `indices.translog.uncommitted_operations`::
  373. (integer)
  374. Number of uncommitted transaction log operations.
  375. `indices.translog.uncommitted_size_in_bytes`::
  376. (integer)
  377. Size, in bytes, of uncommitted transaction log operations.
  378. `indices.translog.earliest_last_modified_age`::
  379. (integer)
  380. Earliest last modified age
  381. for the transaction log.
  382. `indices.request_cache.memory_size_in_bytes`::
  383. (integer)
  384. Memory, in bytes, used by the request cache.
  385. `indices.request_cache.evictions`::
  386. (integer)
  387. Number of request cache operations.
  388. `indices.request_cache.hit_count`::
  389. (integer)
  390. Number of request cache hits.
  391. `indices.request_cache.miss_count`::
  392. (integer)
  393. Number of request cache misses.
  394. `indices.recovery.current_as_source`::
  395. (integer)
  396. Number of recoveries
  397. that used an index shard as a source.
  398. `indices.recovery.current_as_target`::
  399. (integer)
  400. Number of recoveries
  401. that used an index shard as a target.
  402. `indices.recovery.throttle_time_in_millis`::
  403. (integer)
  404. Time in milliseconds
  405. recovery operations were delayed due to throttling.
  406. [[cluster-nodes-stats-api-response-body-fs]]
  407. ===== `fs` section
  408. `fs.timestamp`::
  409. Last time the file stores statistics have been refreshed.
  410. `fs.total.total_in_bytes`::
  411. Total size (in bytes) of all file stores.
  412. `fs.total.free_in_bytes`::
  413. Total number of unallocated bytes in all file stores.
  414. `fs.total.available_in_bytes`::
  415. Total number of bytes available to this Java virtual machine on all file
  416. stores. Depending on OS or process level restrictions, this might appear
  417. less than `fs.total.free_in_bytes`. This is the actual amount of free disk
  418. space the {es} node can utilise.
  419. `fs.data`::
  420. List of all file stores.
  421. `fs.data.path`::
  422. Path to the file store.
  423. `fs.data.mount`::
  424. Mount point of the file store (ex: /dev/sda2).
  425. `fs.data.type`::
  426. Type of the file store (ex: ext4).
  427. `fs.data.total_in_bytes`::
  428. Total size (in bytes) of the file store.
  429. `fs.data.free_in_bytes`::
  430. Total number of unallocated bytes in the file store.
  431. `fs.data.available_in_bytes`::
  432. Total number of bytes available to this Java virtual machine on this file
  433. store.
  434. `fs.io_stats.devices` (Linux only)::
  435. Array of disk metrics for each device that is backing an {es} data path.
  436. These disk metrics are probed periodically and averages between the last
  437. probe and the current probe are computed.
  438. `fs.io_stats.devices.device_name` (Linux only)::
  439. The Linux device name.
  440. `fs.io_stats.devices.operations` (Linux only)::
  441. The total number of read and write operations for the device completed since
  442. starting {es}.
  443. `fs.io_stats.devices.read_operations` (Linux only)::
  444. The total number of read operations for the device completed since starting
  445. {es}.
  446. `fs.io_stats.devices.write_operations` (Linux only)::
  447. The total number of write operations for the device completed since starting
  448. {es}.
  449. `fs.io_stats.devices.read_kilobytes` (Linux only)::
  450. The total number of kilobytes read for the device since starting {es}.
  451. `fs.io_stats.devices.write_kilobytes` (Linux only)::
  452. The total number of kilobytes written for the device since starting {es}.
  453. `fs.io_stats.operations` (Linux only)::
  454. The total number of read and write operations across all devices used by
  455. {es} completed since starting {es}.
  456. `fs.io_stats.read_operations` (Linux only)::
  457. The total number of read operations for across all devices used by {es}
  458. completed since starting {es}.
  459. `fs.io_stats.write_operations` (Linux only)::
  460. The total number of write operations across all devices used by {es}
  461. completed since starting {es}.
  462. `fs.io_stats.read_kilobytes` (Linux only)::
  463. The total number of kilobytes read across all devices used by {es} since
  464. starting {es}.
  465. `fs.io_stats.write_kilobytes` (Linux only)::
  466. The total number of kilobytes written across all devices used by {es} since
  467. starting {es}.
  468. [[cluster-nodes-stats-api-response-body-os]]
  469. ===== `os` section
  470. `os.timestamp`::
  471. Last time the operating system statistics have been refreshed.
  472. `os.cpu.percent`::
  473. Recent CPU usage for the whole system, or -1 if not supported.
  474. `os.cpu.load_average.1m`::
  475. One-minute load average on the system (field is not present if one-minute
  476. load average is not available).
  477. `os.cpu.load_average.5m`::
  478. Five-minute load average on the system (field is not present if five-minute
  479. load average is not available).
  480. `os.cpu.load_average.15m`::
  481. Fifteen-minute load average on the system (field is not present if
  482. fifteen-minute load average is not available).
  483. `os.mem.total_in_bytes`::
  484. Total amount of physical memory in bytes.
  485. `os.mem.free_in_bytes`::
  486. Amount of free physical memory in bytes.
  487. `os.mem.free_percent`::
  488. Percentage of free memory.
  489. `os.mem.used_in_bytes`::
  490. Amount of used physical memory in bytes.
  491. `os.mem.used_percent`::
  492. Percentage of used memory.
  493. `os.swap.total_in_bytes`::
  494. Total amount of swap space in bytes.
  495. `os.swap.free_in_bytes`::
  496. Amount of free swap space in bytes.
  497. `os.swap.used_in_bytes`::
  498. Amount of used swap space in bytes.
  499. `os.cgroup.cpuacct.control_group` (Linux only)::
  500. The `cpuacct` control group to which the {es} process belongs.
  501. `os.cgroup.cpuacct.usage_nanos` (Linux only)::
  502. The total CPU time (in nanoseconds) consumed by all tasks in the same cgroup
  503. as the {es} process.
  504. `os.cgroup.cpu.control_group` (Linux only)::
  505. The `cpu` control group to which the {es} process belongs.
  506. `os.cgroup.cpu.cfs_period_micros` (Linux only)::
  507. The period of time (in microseconds) for how regularly all tasks in the same
  508. cgroup as the {es} process should have their access to CPU resources
  509. reallocated.
  510. `os.cgroup.cpu.cfs_quota_micros` (Linux only)::
  511. The total amount of time (in microseconds) for which all tasks in
  512. the same cgroup as the {es} process can run during one period
  513. `os.cgroup.cpu.cfs_period_micros`.
  514. `os.cgroup.cpu.stat.number_of_elapsed_periods` (Linux only)::
  515. The number of reporting periods (as specified by
  516. `os.cgroup.cpu.cfs_period_micros`) that have elapsed.
  517. `os.cgroup.cpu.stat.number_of_times_throttled` (Linux only)::
  518. The number of times all tasks in the same cgroup as the {es} process have
  519. been throttled.
  520. `os.cgroup.cpu.stat.time_throttled_nanos` (Linux only)::
  521. The total amount of time (in nanoseconds) for which all tasks in the same
  522. cgroup as the {es} process have been throttled.
  523. `os.cgroup.memory.control_group` (Linux only)::
  524. The `memory` control group to which the {es} process belongs.
  525. `os.cgroup.memory.limit_in_bytes` (Linux only)::
  526. The maximum amount of user memory (including file cache) allowed for all
  527. tasks in the same cgroup as the {es} process. This value can be too big to
  528. store in a `long`, so is returned as a string so that the value returned can
  529. exactly match what the underlying operating system interface returns. Any
  530. value that is too large to parse into a `long` almost certainly means no
  531. limit has been set for the cgroup.
  532. `os.cgroup.memory.usage_in_bytes` (Linux only)::
  533. The total current memory usage by processes in the cgroup (in bytes) by all
  534. tasks in the same cgroup as the {es} process. This value is stored as a
  535. string for consistency with `os.cgroup.memory.limit_in_bytes`.
  536. NOTE: For the cgroup stats to be visible, cgroups must be compiled into the
  537. kernel, the `cpu` and `cpuacct` cgroup subsystems must be configured and stats
  538. must be readable from `/sys/fs/cgroup/cpu` and `/sys/fs/cgroup/cpuacct`.
  539. [[cluster-nodes-stats-api-response-body-process]]
  540. ===== `process` section
  541. `process.timestamp`::
  542. Last time the process statistics have been refreshed.
  543. `process.open_file_descriptors`::
  544. Number of opened file descriptors associated with the current process, or -1
  545. if not supported.
  546. `process.max_file_descriptors`::
  547. Maximum number of file descriptors allowed on the system, or -1 if not
  548. supported.
  549. `process.cpu.percent`::
  550. CPU usage in percent, or -1 if not known at the time the stats are computed
  551. `process.cpu.total_in_millis`::
  552. CPU time (in milliseconds) used by the process on which the Java virtual
  553. machine is running, or -1 if not supported.
  554. `process.mem.total_virtual_in_bytes`::
  555. Size in bytes of virtual memory that is guaranteed to be available to the
  556. running process.
  557. [[cluster-nodes-stats-api-response-body-jvm]]
  558. ===== `jvm` section
  559. `jvm.timestamp`::
  560. (integer)
  561. Last time JVM statistics were refreshed.
  562. `jvm.uptime_in_millis`::
  563. (integer)
  564. JVM uptime in milliseconds.
  565. `jvm.mem.heap_used_in_bytes`::
  566. (integer)
  567. Memory, in bytes, currently in use by the heap.
  568. `jvm.mem.heap_used_percent`::
  569. (integer)
  570. Percentage of memory currently in use by the heap.
  571. `jvm.mem.heap_committed_in_bytes`::
  572. (integer)
  573. Amount of memory, in bytes, available for use by the heap.
  574. `jvm.mem.heap_max_in_bytes`::
  575. (integer)
  576. Maximum amount of memory, in bytes, available for use by the heap.
  577. `jvm.mem.non_heap_used_in_bytes`::
  578. (integer)
  579. Non-heap memory used, in bytes.
  580. `jvm.mem.non_heap_committed_in_bytes`::
  581. (integer)
  582. Amount of non-heap memory available, in bytes.
  583. `jvm.mem.pools.young.used_in_bytes`::
  584. (integer)
  585. Memory, in bytes, used by the young generation heap.
  586. `jvm.mem.pools.young.max_in_bytes`::
  587. (integer)
  588. Maximum amount of memory, in bytes, available for use by the young generation
  589. heap.
  590. `jvm.mem.pools.young.peak_used_in_bytes`::
  591. (integer)
  592. Largest amount of memory, in bytes, historically used by the young generation
  593. heap.
  594. `jvm.mem.pools.young.peak_max_in_bytes`::
  595. (integer)
  596. Largest amount of memory, in bytes, historically used by the young generation
  597. heap.
  598. `jvm.mem.pools.survivor.used_in_bytes`::
  599. (integer)
  600. Memory, in bytes, used by the survivor space.
  601. `jvm.mem.pools.survivor.max_in_bytes`::
  602. (integer)
  603. Maximum amount of memory, in bytes, available for use by the survivor space.
  604. `jvm.mem.pools.survivor.peak_used_in_bytes`::
  605. (integer)
  606. Largest amount of memory, in bytes, historically used by the survivor space.
  607. `jvm.mem.pools.survivor.peak_max_in_bytes`::
  608. (integer)
  609. Largest amount of memory, in bytes, historically used by the survivor space.
  610. `jvm.mem.pools.old.used_in_bytes`::
  611. (integer)
  612. Memory, in bytes, used by the old generation heap.
  613. `jvm.mem.pools.old.max_in_bytes`::
  614. (integer)
  615. Maximum amount of memory, in bytes, available for use by the old generation
  616. heap.
  617. `jvm.mem.pools.old.peak_used_in_bytes`::
  618. (integer)
  619. Largest amount of memory, in bytes, historically used by the old generation
  620. heap.
  621. `jvm.mem.pools.old.peak_max_in_bytes`::
  622. (integer)
  623. Highest memory limit, in bytes, historically available for use by the old
  624. generation heap.
  625. `jvm.threads.count`::
  626. (integer)
  627. Number of active threads in use by JVM.
  628. `jvm.threads.peak_count`::
  629. (integer)
  630. Highest number of threads used by JVM.
  631. `jvm.gc.collectors.young.collection_count`::
  632. (integer)
  633. Number of JVM garbage collectors that collect young generation objects.
  634. `jvm.gc.collectors.young.collection_time_in_millis`::
  635. (integer)
  636. Total time in milliseconds spent by JVM collecting young generation objects.
  637. `jvm.gc.collectors.old.collection_count`::
  638. (integer)
  639. Number of JVM garbage collectors that collect old generation objects.
  640. `jvm.gc.collectors.old.collection_time_in_millis`::
  641. (integer)
  642. Total time in milliseconds spent by JVM collecting old generation objects.
  643. `jvm.buffer_pools.mapped.count`::
  644. (integer)
  645. Number of mapped buffer pools.
  646. `jvm.buffer_pools.mapped.used_in_bytes`::
  647. (integer)
  648. Size, in bytes, of mapped buffer pools.
  649. `jvm.buffer_pools.mapped.total_capacity_in_bytes`::
  650. (integer)
  651. Total capacity, in bytes, of mapped buffer pools.
  652. `jvm.buffer_pools.direct.count`::
  653. (integer)
  654. Number of direct buffer pools.
  655. `jvm.buffer_pools.direct.used_in_bytes`::
  656. (integer)
  657. Size, in bytes, of direct buffer pools.
  658. `jvm.buffer_pools.direct.total_capacity_in_bytes`::
  659. (integer)
  660. Total capacity, in bytes, of direct buffer pools.
  661. `jvm.classes.current_loaded_count`::
  662. (integer)
  663. Number of buffer pool classes currently loaded by JVM.
  664. `jvm.classes.total_loaded_count`::
  665. (integer)
  666. Total number of buffer pool classes loaded since the JVM started.
  667. `jvm.classes.total_unloaded_count`::
  668. (integer)
  669. Total number of buffer pool classes unloaded since the JVM started.
  670. [[cluster-nodes-stats-api-response-body-threadpool]]
  671. ===== `thread_pool` section
  672. `thread_pool.<thread_pool_name>.threads`::
  673. (integer)
  674. Number of threads in the thread pool.
  675. `thread_pool.<thread_pool_name>.queue`::
  676. (integer)
  677. Number of tasks in queue for the thread pool.
  678. `thread_pool.<thread_pool_name>.active`::
  679. (integer)
  680. Number of active threads in the thread pool.
  681. `thread_pool.<thread_pool_name>.rejected`::
  682. (integer)
  683. Number of tasks rejected by the thread pool executor.
  684. `thread_pool.<thread_pool_name>.largest`::
  685. (integer)
  686. Highest number of active threads in the thread pool.
  687. `thread_pool.<thread_pool_name>.completed`::
  688. (integer)
  689. Number of tasks completed by the thread pool executor.
  690. [[cluster-nodes-stats-api-response-body-transport]]
  691. ===== `transport` section
  692. `transport.server_open`::
  693. (integer)
  694. Number of open TCP connections used for internal communication between nodes.
  695. `transport.rx_count`::
  696. (integer)
  697. Total number of RX (receive) packets received by the node during internal
  698. cluster communication.
  699. `transport.rx_size_in_bytes`::
  700. (integer)
  701. Size, in bytes, of RX packets received by the node during internal cluster
  702. communication.
  703. `transport.tx_count`::
  704. (integer)
  705. Total number of TX (transmit) packets sent by the node during internal cluster
  706. communication.
  707. `transport.tx_size_in_bytes`::
  708. (integer)
  709. Size, in bytes, of TX packets sent by the node during internal cluster
  710. communication.
  711. [[cluster-nodes-stats-api-response-body-http]]
  712. ===== `http` section
  713. `http.current_open`::
  714. (integer)
  715. Current number of open HTTP connections for the node.
  716. `http.total_opened`::
  717. (integer)
  718. Total number of HTTP connections opened for the node.
  719. [[cluster-nodes-stats-api-response-body-ingest]]
  720. ===== `ingest` section
  721. `ingest.total.count`::
  722. (integer)
  723. Total number of documents ingested during the lifetime of this node.
  724. `ingest.total.time_in_millis`::
  725. (integer)
  726. Total time spent preprocessing ingest documents during the lifetime of this
  727. node.
  728. `ingest.total.current`::
  729. (integer)
  730. Total number of documents currently being ingested.
  731. `ingest.total.failed`::
  732. (integer)
  733. Total number of failed ingest operations during the lifetime of this node.
  734. `ingest.pipelines.<pipeline_id>.count`::
  735. (integer)
  736. Number of documents preprocessed by the ingest pipeline.
  737. `ingest.pipelines.<pipeline_id>.time_in_millis`::
  738. (integer)
  739. Total time spent preprocessing documents in the ingest pipeline.
  740. `ingest.pipelines.<pipeline_id>.failed`::
  741. (integer)
  742. Total number of failed operations for the ingest pipeline.
  743. `ingest.pipelines.<pipeline_id>.<processor>.count`::
  744. (integer)
  745. Number of documents transformed by the processor.
  746. `ingest.pipelines.<pipeline_id>.<processor>.time_in_millis`::
  747. (integer)
  748. Time spent by the processor transforming documents.
  749. `ingest.pipelines.<pipeline_id>.<processor>.current`::
  750. (integer)
  751. Number of documents currently being transformed by the processor.
  752. `ingest.pipelines.<pipeline_id>.<processor>.failed`::
  753. (integer)
  754. Number of failed operations for the processor.
  755. [[cluster-nodes-stats-api-response-body-adaptive-selection]]
  756. ===== `adaptive_selection` section
  757. The `adaptive_selection` statistics are keyed by node. For each node:
  758. `adaptive_selection.outgoing_searches`::
  759. The number of outstanding search requests from the node these stats are for
  760. to the keyed node.
  761. `avg_queue_size`::
  762. The exponentially weighted moving average queue size of search requests on
  763. the keyed node.
  764. `avg_service_time_ns`::
  765. The exponentially weighted moving average service time of search requests on
  766. the keyed node.
  767. `avg_response_time_ns`::
  768. The exponentially weighted moving average response time of search requests
  769. on the keyed node.
  770. `rank`::
  771. The rank of this node; used for shard selection when routing search
  772. requests.
  773. [[cluster-nodes-stats-api-example]]
  774. ==== {api-examples-title}
  775. [source,console]
  776. --------------------------------------------------
  777. # return just indices
  778. GET /_nodes/stats/indices
  779. # return just os and process
  780. GET /_nodes/stats/os,process
  781. # return just process for node with IP address 10.0.0.1
  782. GET /_nodes/10.0.0.1/stats/process
  783. --------------------------------------------------
  784. All stats can be explicitly requested via `/_nodes/stats/_all` or
  785. `/_nodes/stats?metric=_all`.
  786. You can get information about indices stats on `node`, `indices`, or `shards`
  787. level.
  788. [source,console]
  789. --------------------------------------------------
  790. # Fielddata summarized by node
  791. GET /_nodes/stats/indices/fielddata?fields=field1,field2
  792. # Fielddata summarized by node and index
  793. GET /_nodes/stats/indices/fielddata?level=indices&fields=field1,field2
  794. # Fielddata summarized by node, index, and shard
  795. GET /_nodes/stats/indices/fielddata?level=shards&fields=field1,field2
  796. # You can use wildcards for field names
  797. GET /_nodes/stats/indices/fielddata?fields=field*
  798. --------------------------------------------------
  799. You can get statistics about search groups for searches executed
  800. on this node.
  801. [source,console]
  802. --------------------------------------------------
  803. # All groups with all stats
  804. GET /_nodes/stats?groups=_all
  805. # Some groups from just the indices stats
  806. GET /_nodes/stats/indices?groups=foo,bar
  807. --------------------------------------------------
  808. [[cluster-nodes-stats-ingest-ex]]
  809. ===== Retrieve ingest statistics only
  810. To return only ingest-related node statistics, set the `<metric>` path
  811. parameter to `ingest` and use the
  812. <<common-options-response-filtering,`filter_path`>> query parameter.
  813. [source,console]
  814. --------------------------------------------------
  815. GET /_nodes/stats/ingest?filter_path=nodes.*.ingest
  816. --------------------------------------------------
  817. You can use the `metric` and `filter_path` query parameters to get the same
  818. response.
  819. [source,console]
  820. --------------------------------------------------
  821. GET /_nodes/stats?metric=ingest&filter_path=nodes.*.ingest
  822. --------------------------------------------------
  823. To further refine the response, change the `filter_path` value.
  824. For example, the following request only returns ingest pipeline statistics.
  825. [source,console]
  826. --------------------------------------------------
  827. GET /_nodes/stats?metric=ingest&filter_path=nodes.*.ingest.pipelines
  828. --------------------------------------------------