Skip to content

Commit 17ffe74

Browse files
committed
(Doc+) CAT Nodes default columns (elastic#112715)
👋 howdy, team! 1. Related to elastic/dev#2631, highlights customers are usually seeking `heap.percent` instead of `ram.percent` 2. Aligns the claimed "(Default)" columns in doc to what returned for v8.15.1 test cluster
1 parent 05323e7 commit 17ffe74

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/reference/cat/nodes.asciidoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,16 @@ Valid columns are:
5050
(Default) IP address, such as `127.0.1.1`.
5151

5252
`heap.percent`, `hp`, `heapPercent`::
53-
(Default) Maximum configured heap, such as `7`.
53+
(Default) Used percentage of total allocated Elasticsearch JVM heap, such as `7`. This reflects only the {es} process running within the operating system and is the most direct indicator of its JVM/heap/memory resource performance.
5454

5555
`heap.max`, `hm`, `heapMax`::
56-
(Default) Total heap, such as `4gb`.
56+
Total heap, such as `4gb`.
5757

5858
`ram.percent`, `rp`, `ramPercent`::
59-
(Default) Used total memory percentage, such as `47`.
59+
(Default) Used percentage of total operating system's memory, such as `47`. This reflects all processes running on operating system instead of only {es} and is not guaranteed to correlate to its performance.
6060

6161
`file_desc.percent`, `fdp`, `fileDescriptorPercent`::
62-
(Default) Used file descriptors percentage, such as `1`.
62+
Used file descriptors percentage, such as `1`.
6363

6464
`node.role`, `r`, `role`, `nodeRole`::
6565
(Default) Roles of the node.
@@ -138,16 +138,16 @@ Used file descriptors, such as `123`.
138138
Maximum number of file descriptors, such as `1024`.
139139

140140
`cpu`::
141-
Recent system CPU usage as percent, such as `12`.
141+
(Default) Recent system CPU usage as percent, such as `12`.
142142

143143
`load_1m`, `l`::
144-
Most recent load average, such as `0.22`.
144+
(Default) Most recent load average, such as `0.22`.
145145

146146
`load_5m`, `l`::
147-
Load average for the last five minutes, such as `0.78`.
147+
(Default) Load average for the last five minutes, such as `0.78`.
148148

149149
`load_15m`, `l`::
150-
Load average for the last fifteen minutes, such as `1.24`.
150+
(Default) Load average for the last fifteen minutes, such as `1.24`.
151151

152152
`uptime`, `u`::
153153
Node uptime, such as `17.3m`.

0 commit comments

Comments
 (0)