Skip to content

Commit 079855e

Browse files
committed
[DOC] Update /_cat/nodes doc
closes #20162
1 parent 30e1375 commit 079855e

File tree

1 file changed

+28
-41
lines changed

1 file changed

+28
-41
lines changed

docs/reference/cat/nodes.asciidoc

Lines changed: 28 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -3,48 +3,35 @@
33

44
The `nodes` command shows the cluster topology.
55

6-
["source","sh",subs="attributes,callouts"]
7-
--------------------------------------------------
8-
% curl 192.168.56.10:9200/_cat/nodes
9-
SP4H 4727 192.168.56.30 9300 {version} {jdk} 72.1gb 35.4 93.9mb 79 239.1mb 0.45 3.4h mdi - Boneyard
10-
_uhJ 5134 192.168.56.10 9300 {version} {jdk} 72.1gb 33.3 93.9mb 85 239.1mb 0.06 3.4h mdi * Athena
11-
HfDp 4562 192.168.56.20 9300 {version} {jdk} 72.2gb 74.5 93.9mb 83 239.1mb 0.12 3.4h mdi - Zarek
12-
--------------------------------------------------
13-
14-
The first few columns tell you where your nodes live. For sanity it
15-
also tells you what version of ES and the JVM each one runs.
16-
17-
["source","sh",subs="attributes,callouts"]
6+
[source,sh]
187
--------------------------------------------------
19-
nodeId pid ip port version jdk
20-
u2PZ 4234 192.168.56.30 9300 {version} {jdk}
21-
URzf 5443 192.168.56.10 9300 {version} {jdk}
22-
ActN 3806 192.168.56.20 9300 {version} {jdk}
8+
% GET /_cat/nodes
9+
192.168.56.30 9 78 22 1.80 2.05 2.51 mdi * bGG90GE
10+
192.168.56.10 6 75 14 1.24 2.45 1.37 md - I8hydUG
11+
192.168.56.20 5 71 12 1.07 1.05 1.11 di - H5dfFeA
2312
--------------------------------------------------
2413

25-
26-
The next few give a picture of your heap, memory, and load.
14+
The first few columns tell you where your nodes live and give
15+
a picture of your heap, memory, cpu and load.
2716

2817
[source,sh]
2918
--------------------------------------------------
30-
diskAvail heapPercent heapMax ramPercent ramMax load
31-
72.1gb 31.3 93.9mb 81 239.1mb 0.24
32-
72.1gb 19.6 93.9mb 82 239.1mb 0.05
33-
72.2gb 64.9 93.9mb 84 239.1mb 0.12
19+
ip heap.percent ram.percent cpu load_1m load_5m load_15m
20+
192.168.56.30 9 78 22 1.80 2.05 2.51
21+
192.168.56.10 6 75 14 1.24 2.45 1.37
22+
192.168.56.20 5 71 12 1.07 1.05 1.11
3423
--------------------------------------------------
3524

3625
The last columns provide ancillary information that can often be
3726
useful when looking at the cluster as a whole, particularly large
38-
ones. How many master-eligible nodes do I have? How many client
39-
nodes? It looks like someone restarted a node recently; which one was
40-
it?
27+
ones. How many master-eligible nodes do I have?
4128

4229
[source,sh]
4330
--------------------------------------------------
44-
uptime node.role master name
45-
3.5h di - Boneyard
46-
3.5h md * Athena
47-
3.5h i - Zarek
31+
node.role master name
32+
mdi * bGG90GE
33+
md - I8hydUG
34+
di - H5dfFeA
4835
--------------------------------------------------
4936

5037
[float]
@@ -65,7 +52,7 @@ by default. To have the headers appear in the output, use verbose
6552
mode (`v`). The header name will match the supplied value (e.g.,
6653
`pid` versus `p`). For example:
6754

68-
["source","sh",subs="attributes,callouts"]
55+
[source,sh]
6956
--------------------------------------------------
7057
% curl 192.168.56.10:9200/_cat/nodes?v&h=id,ip,port,v,m
7158
id ip port v m
@@ -102,13 +89,15 @@ descriptors |123
10289
descriptors percentage |1
10390
|`file_desc.max` |`fdm`, `fileDescriptorMax` |No |Maximum number of file
10491
descriptors |1024
105-
|`load` |`l` |No |Most recent load average |0.22
10692
|`cpu` | |No |Recent system CPU usage as percent |12
93+
|`load_1m` |`l` |No |Most recent load average |0.22
94+
|`load_5m` |`l` |No |Load average for the last five minutes |0.78
95+
|`load_15m` |`l` |No |Load average for the last fifteen minutes |1.24
10796
|`uptime` |`u` |No |Node uptime |17.3m
10897
|`node.role` |`r`, `role`, `nodeRole` |Yes |Master eligible node (m);
10998
Data node (d); Ingest node (i); Coordinating node only (-) |mdi
11099
|`master` |`m` |Yes |Elected master (*); Not elected master (-) |*
111-
|`name` |`n` |Yes |Node name |Venom
100+
|`name` |`n` |Yes |Node name |I8hydUG
112101
|`completion.size` |`cs`, `completionSize` |No |Size of completion |0b
113102
|`fielddata.memory_size` |`fm`, `fielddataMemory` |No |Used fielddata
114103
cache memory |0b
@@ -152,6 +141,8 @@ of current indexing operations |0
152141
indexing |134ms
153142
|`indexing.index_total` |`iito`, `indexingIndexTotal` |No |Number of
154143
indexing operations |1
144+
|`indexing.index_failed` |`iif`, `indexingIndexFailed` |No |Number of
145+
failed indexing operations |0
155146
|`merges.current` |`mc`, `mergesCurrent` |No |Number of current
156147
merge operations |0
157148
|`merges.current_docs` |`mcd`, `mergesCurrentDocs` |No |Number of
@@ -166,15 +157,6 @@ documents |0
166157
merges |0b
167158
|`merges.total_time` |`mtt`, `mergesTotalTime` |No |Time spent merging
168159
documents |0s
169-
|`percolate.current` |`pc`, `percolateCurrent` |No |Number of current
170-
percolations |0
171-
|`percolate.memory_size` |`pm`, `percolateMemory` |No |Memory used by
172-
current percolations |0b
173-
|`percolate.queries` |`pq`, `percolateQueries` |No |Number of
174-
registered percolation queries |0
175-
|`percolate.time` |`pti`, `percolateTime` |No |Time spent
176-
percolating |0s
177-
|`percolate.total` |`pto`, `percolateTotal` |No |Total percolations |0
178160
|`refresh.total` |`rto`, `refreshTotal` |No |Number of refreshes |16
179161
|`refresh.time` |`rti`, `refreshTime` |No |Time spent in refreshes |91ms
180162
|`script.compilations` |`scrcc`, `scriptCompilations` |No |Total script compilations |17
@@ -203,4 +185,9 @@ segments |1.4kb
203185
|Memory used by index writer |18mb
204186
|`segments.version_map_memory` |`svmm`, `segmentsVersionMapMemory` |No
205187
|Memory used by version map |1.0kb
188+
|`segments.fixed_bitset_memory` |`sfbm`, `fixedBitsetMemory` |No
189+
|Memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields |1.0kb
190+
|`suggest.current` |`suc`, `suggestCurrent` |No |Number of current suggest operations |0
191+
|`suggest.time` |`suti`, `suggestTime` |No |Time spent in suggest |0
192+
|`suggest.total` |`suto`, `suggestTotal` |No |Number of suggest operations |0
206193
|=======================================================================

0 commit comments

Comments
 (0)