nodes.asciidoc 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188
  1. [[cat-nodes]]
  2. == cat nodes
  3. The `nodes` command shows the cluster topology. For example
  4. [source,js]
  5. --------------------------------------------------
  6. GET /_cat/nodes?v
  7. --------------------------------------------------
  8. // CONSOLE
  9. Might look like:
  10. [source,txt]
  11. --------------------------------------------------
  12. ip heap.percent ram.percent cpu load_1m load_5m load_15m node.role master name
  13. 127.0.0.1 65 99 42 3.07 mdi * mJw06l1
  14. --------------------------------------------------
  15. // TESTRESPONSE[s/3.07/(\\d+\\.\\d+( \\d+\\.\\d+ (\\d+\\.\\d+)?)?)?/]
  16. // TESTRESPONSE[s/65 99 42/\\d+ \\d+ \\d+/]
  17. // TESTRESPONSE[s/[*]/[*]/ s/mJw06l1/.+/ _cat]
  18. The first few columns (`ip, `heap.percent`, `ram.percent`, `cpu, `load_*`) tell
  19. you where your nodes live and give a quick picture of performance stats.
  20. The last (`node.role`, `master`, and `name`) columns provide ancillary
  21. information that can often be useful when looking at the cluster as a whole,
  22. particularly large ones. How many master-eligible nodes do I have?
  23. [float]
  24. === Columns
  25. Below is an exhaustive list of the existing headers that can be
  26. passed to `nodes?h=` to retrieve the relevant details in ordered
  27. columns. If no headers are specified, then those marked to Appear
  28. by Default will appear. If any header is specified, then the defaults
  29. are not used.
  30. Aliases can be used in place of the full header name for brevity.
  31. Columns appear in the order that they are listed below unless a
  32. different order is specified (e.g., `h=pid,id` versus `h=id,pid`).
  33. When specifying headers, the headers are not placed in the output
  34. by default. To have the headers appear in the output, use verbose
  35. mode (`v`). The header name will match the supplied value (e.g.,
  36. `pid` versus `p`). For example:
  37. [source,js]
  38. --------------------------------------------------
  39. GET /_cat/nodes?v&h=id,ip,port,v,m
  40. --------------------------------------------------
  41. // CONSOLE
  42. Might look like:
  43. ["source","js",subs="attributes,callouts"]
  44. --------------------------------------------------
  45. id ip port v m
  46. veJR 127.0.0.1 59938 {version} *
  47. --------------------------------------------------
  48. // TESTRESPONSE[s/veJR/.+/ s/59938/\\d+/ s/[*]/[*]/ _cat]
  49. [cols="<,<,<,<,<",options="header",subs="normal"]
  50. |=======================================================================
  51. |Header |Alias |Appear by Default |Description |Example
  52. |`id` |`nodeId` |No |Unique node ID |k0zy
  53. |`pid` |`p` |No |Process ID |13061
  54. |`ip` |`i` |Yes |IP address |127.0.1.1
  55. |`port` |`po` |No |Bound transport port |9300
  56. |`http_address` |`http`| No | bound http address | 127.0.0.1:9200
  57. |`version` |`v` |No |Elasticsearch version |{version}
  58. |`build` |`b` |No |Elasticsearch Build hash |5c03844
  59. |`jdk` |`j` |No |Running Java version |1.8.0
  60. |`disk.avail` |`d`, `disk`, `diskAvail` |No |Available disk space |1.8gb
  61. |`heap.current` |`hc`, `heapCurrent` |No |Used heap |311.2mb
  62. |`heap.percent` |`hp`, `heapPercent` |Yes |Used heap percentage |7
  63. |`heap.max` |`hm`, `heapMax` |No |Maximum configured heap |1015.6mb
  64. |`ram.current` |`rc`, `ramCurrent` |No |Used total memory |513.4mb
  65. |`ram.percent` |`rp`, `ramPercent` |Yes |Used total memory percentage |47
  66. |`ram.max` |`rm`, `ramMax` |No |Total memory |2.9gb
  67. |`file_desc.current` |`fdc`, `fileDescriptorCurrent` |No |Used file
  68. descriptors |123
  69. |`file_desc.percent` |`fdp`, `fileDescriptorPercent` |Yes |Used file
  70. descriptors percentage |1
  71. |`file_desc.max` |`fdm`, `fileDescriptorMax` |No |Maximum number of file
  72. descriptors |1024
  73. |`cpu` | |No |Recent system CPU usage as percent |12
  74. |`load_1m` |`l` |No |Most recent load average |0.22
  75. |`load_5m` |`l` |No |Load average for the last five minutes |0.78
  76. |`load_15m` |`l` |No |Load average for the last fifteen minutes |1.24
  77. |`uptime` |`u` |No |Node uptime |17.3m
  78. |`node.role` |`r`, `role`, `nodeRole` |Yes |Master eligible node (m);
  79. Data node (d); Ingest node (i); Coordinating node only (-) |mdi
  80. |`master` |`m` |Yes |Elected master (*); Not elected master (-) |*
  81. |`name` |`n` |Yes |Node name |I8hydUG
  82. |`completion.size` |`cs`, `completionSize` |No |Size of completion |0b
  83. |`fielddata.memory_size` |`fm`, `fielddataMemory` |No |Used fielddata
  84. cache memory |0b
  85. |`fielddata.evictions` |`fe`, `fielddataEvictions` |No |Fielddata cache
  86. evictions |0
  87. |`query_cache.memory_size` |`qcm`, `queryCacheMemory` |No |Used query
  88. cache memory |0b
  89. |`query_cache.evictions` |`qce`, `queryCacheEvictions` |No |Query
  90. cache evictions |0
  91. |`request_cache.memory_size` |`rcm`, `requestCacheMemory` |No | Used request
  92. cache memory |0b
  93. |`request_cache.evictions` |`rce`, `requestCacheEvictions` |No |Request
  94. cache evictions |0
  95. |`request_cache.hit_count` |`rchc`, `requestCacheHitCount` |No | Request
  96. cache hit count |0
  97. |`request_cache.miss_count` |`rcmc`, `requestCacheMissCount` |No | Request
  98. cache miss count |0
  99. |`flush.total` |`ft`, `flushTotal` |No |Number of flushes |1
  100. |`flush.total_time` |`ftt`, `flushTotalTime` |No |Time spent in flush |1
  101. |`get.current` |`gc`, `getCurrent` |No |Number of current get
  102. operations |0
  103. |`get.time` |`gti`, `getTime` |No |Time spent in get |14ms
  104. |`get.total` |`gto`, `getTotal` |No |Number of get operations |2
  105. |`get.exists_time` |`geti`, `getExistsTime` |No |Time spent in
  106. successful gets |14ms
  107. |`get.exists_total` |`geto`, `getExistsTotal` |No |Number of successful
  108. get operations |2
  109. |`get.missing_time` |`gmti`, `getMissingTime` |No |Time spent in failed
  110. gets |0s
  111. |`get.missing_total` |`gmto`, `getMissingTotal` |No |Number of failed
  112. get operations |1
  113. |`indexing.delete_current` |`idc`, `indexingDeleteCurrent` |No |Number
  114. of current deletion operations |0
  115. |`indexing.delete_time` |`idti`, `indexingDeleteTime` |No |Time spent in
  116. deletions |2ms
  117. |`indexing.delete_total` |`idto`, `indexingDeleteTotal` |No |Number of
  118. deletion operations |2
  119. |`indexing.index_current` |`iic`, `indexingIndexCurrent` |No |Number
  120. of current indexing operations |0
  121. |`indexing.index_time` |`iiti`, `indexingIndexTime` |No |Time spent in
  122. indexing |134ms
  123. |`indexing.index_total` |`iito`, `indexingIndexTotal` |No |Number of
  124. indexing operations |1
  125. |`indexing.index_failed` |`iif`, `indexingIndexFailed` |No |Number of
  126. failed indexing operations |0
  127. |`merges.current` |`mc`, `mergesCurrent` |No |Number of current
  128. merge operations |0
  129. |`merges.current_docs` |`mcd`, `mergesCurrentDocs` |No |Number of
  130. current merging documents |0
  131. |`merges.current_size` |`mcs`, `mergesCurrentSize` |No |Size of current
  132. merges |0b
  133. |`merges.total` |`mt`, `mergesTotal` |No |Number of completed merge
  134. operations |0
  135. |`merges.total_docs` |`mtd`, `mergesTotalDocs` |No |Number of merged
  136. documents |0
  137. |`merges.total_size` |`mts`, `mergesTotalSize` |No |Size of current
  138. merges |0b
  139. |`merges.total_time` |`mtt`, `mergesTotalTime` |No |Time spent merging
  140. documents |0s
  141. |`refresh.total` |`rto`, `refreshTotal` |No |Number of refreshes |16
  142. |`refresh.time` |`rti`, `refreshTime` |No |Time spent in refreshes |91ms
  143. |`script.compilations` |`scrcc`, `scriptCompilations` |No |Total script compilations |17
  144. |`script.cache_evictions` |`scrce`, `scriptCacheEvictions` |No |Total compiled scripts evicted from cache |6
  145. |`search.fetch_current` |`sfc`, `searchFetchCurrent` |No |Current fetch
  146. phase operations |0
  147. |`search.fetch_time` |`sfti`, `searchFetchTime` |No |Time spent in fetch
  148. phase |37ms
  149. |`search.fetch_total` |`sfto`, `searchFetchTotal` |No |Number of fetch
  150. operations |7
  151. |`search.open_contexts` |`so`, `searchOpenContexts` |No |Open search
  152. contexts |0
  153. |`search.query_current` |`sqc`, `searchQueryCurrent` |No |Current query
  154. phase operations |0
  155. |`search.query_time` |`sqti`, `searchQueryTime` |No |Time spent in query
  156. phase |43ms
  157. |`search.query_total` |`sqto`, `searchQueryTotal` |No |Number of query
  158. operations |9
  159. |`search.scroll_current` |`scc`, `searchScrollCurrent` |No |Open scroll contexts |2
  160. |`search.scroll_time` |`scti`, `searchScrollTime` |No |Time scroll contexts held open|2m
  161. |`search.scroll_total` |`scto`, `searchScrollTotal` |No |Completed scroll contexts |1
  162. |`segments.count` |`sc`, `segmentsCount` |No |Number of segments |4
  163. |`segments.memory` |`sm`, `segmentsMemory` |No |Memory used by
  164. segments |1.4kb
  165. |`segments.index_writer_memory` |`siwm`, `segmentsIndexWriterMemory` |No
  166. |Memory used by index writer |18mb
  167. |`segments.version_map_memory` |`svmm`, `segmentsVersionMapMemory` |No
  168. |Memory used by version map |1.0kb
  169. |`segments.fixed_bitset_memory` |`sfbm`, `fixedBitsetMemory` |No
  170. |Memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields |1.0kb
  171. |`suggest.current` |`suc`, `suggestCurrent` |No |Number of current suggest operations |0
  172. |`suggest.time` |`suti`, `suggestTime` |No |Time spent in suggest |0
  173. |`suggest.total` |`suto`, `suggestTotal` |No |Number of suggest operations |0
  174. |=======================================================================