nodes.asciidoc 8.8 KB

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