honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/cat/nodes.asciidoc

198 lines
8.8 KiB
Plaintext
Raw Normal View History

First pass at cat docs.
2013-11-14 20:14:39 -05:00
[[cat-nodes]]
[DOCS] Renamed the "cat" chapters to be more searchable
2014-05-16 15:43:35 -04:00
== cat nodes
First pass at cat docs.
2013-11-14 20:14:39 -05:00
The `nodes` command shows the cluster topology.
Docs: Made current version, branch and jdk into asciidoc attributes
2014-07-23 05:54:53 -04:00
["source","sh",subs="attributes,callouts"]
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
% curl 192.168.56.10:9200/_cat/nodes
Docs: Made current version, branch and jdk into asciidoc attributes
2014-07-23 05:54:53 -04:00
SP4H 4727 192.168.56.30 9300 {version} {jdk} 72.1gb 35.4 93.9mb 79 239.1mb 0.45 3.4h d m Boneyard
_uhJ 5134 192.168.56.10 9300 {version} {jdk} 72.1gb 33.3 93.9mb 85 239.1mb 0.06 3.4h d * Athena
HfDp 4562 192.168.56.20 9300 {version} {jdk} 72.2gb 74.5 93.9mb 83 239.1mb 0.12 3.4h d m Zarek
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
The first few columns tell you where your nodes live. For sanity it
also tells you what version of ES and the JVM each one runs.
Docs: Made current version, branch and jdk into asciidoc attributes
2014-07-23 05:54:53 -04:00
["source","sh",subs="attributes,callouts"]
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
[DOCS] Update nodes documentation with all headers Adds a table with the exhaustive list of all available headers with a brief description (mostly from `org.elasticsearch.rest.action.cat.RestNodesAction`) so that people do not need to go searching for them in the code like I did, or search through `nodes?help`.
2014-03-27 01:19:54 -04:00
nodeId pid ip port version jdk
Docs: Made current version, branch and jdk into asciidoc attributes
2014-07-23 05:54:53 -04:00
u2PZ 4234 192.168.56.30 9300 {version} {jdk}
URzf 5443 192.168.56.10 9300 {version} {jdk}
ActN 3806 192.168.56.20 9300 {version} {jdk}
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
The next few give a picture of your heap, memory, and load.
Docs: Use "js" instead of "json" and "sh" instead of "shell" for source highlighting
2015-07-14 12:14:09 -04:00
[source,sh]
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
diskAvail heapPercent heapMax ramPercent ramMax load
72.1gb 31.3 93.9mb 81 239.1mb 0.24
72.1gb 19.6 93.9mb 82 239.1mb 0.05
72.2gb 64.9 93.9mb 84 239.1mb 0.12
--------------------------------------------------
The last columns provide ancillary information that can often be
useful when looking at the cluster as a whole, particularly large
ones. How many master-eligible nodes do I have? How many client
nodes? It looks like someone restarted a node recently; which one was
it?
Docs: Use "js" instead of "json" and "sh" instead of "shell" for source highlighting
2015-07-14 12:14:09 -04:00
[source,sh]
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
uptime data/client master name
3.5h d m Boneyard
3.5h d * Athena
3.5h d m Zarek
--------------------------------------------------
[DOCS] Update nodes documentation with all headers Adds a table with the exhaustive list of all available headers with a brief description (mostly from `org.elasticsearch.rest.action.cat.RestNodesAction`) so that people do not need to go searching for them in the code like I did, or search through `nodes?help`.
2014-03-27 01:19:54 -04:00
[float]
=== Columns
Below is an exhaustive list of the existing headers that can be
passed to `nodes?h=` to retrieve the relevant details in ordered
columns. If no headers are specified, then those marked to Appear
by Default will appear. If any header is specified, then the defaults
are not used.
Aliases can be used in place of the full header name for brevity.
Columns appear in the order that they are listed below unless a
different order is specified (e.g., `h=pid,id` versus `h=id,pid`).
When specifying headers, the headers are not placed in the output
by default. To have the headers appear in the output, use verbose
mode (`v`). The header name will match the supplied value (e.g.,
`pid` versus `p`). For example:
Docs: Made current version, branch and jdk into asciidoc attributes
2014-07-23 05:54:53 -04:00
["source","sh",subs="attributes,callouts"]
[DOCS] Update nodes documentation with all headers Adds a table with the exhaustive list of all available headers with a brief description (mostly from `org.elasticsearch.rest.action.cat.RestNodesAction`) so that people do not need to go searching for them in the code like I did, or search through `nodes?help`.
2014-03-27 01:19:54 -04:00
--------------------------------------------------
Docs: Removing escape character The escape character `\` doesn't work and should be removed from the documentation. Closes #8029
2014-10-08 17:11:24 -04:00
% curl 192.168.56.10:9200/_cat/nodes?v&h=id,ip,port,v,m
[DOCS] Update nodes documentation with all headers Adds a table with the exhaustive list of all available headers with a brief description (mostly from `org.elasticsearch.rest.action.cat.RestNodesAction`) so that people do not need to go searching for them in the code like I did, or search through `nodes?help`.
2014-03-27 01:19:54 -04:00
id ip port version m
Docs: Made current version, branch and jdk into asciidoc attributes
2014-07-23 05:54:53 -04:00
pLSN 192.168.56.30 9300 {version} m
k0zy 192.168.56.10 9300 {version} m
6Tyi 192.168.56.20 9300 {version} *
[DOCS] Update nodes documentation with all headers Adds a table with the exhaustive list of all available headers with a brief description (mostly from `org.elasticsearch.rest.action.cat.RestNodesAction`) so that people do not need to go searching for them in the code like I did, or search through `nodes?help`.
2014-03-27 01:19:54 -04:00
% curl 192.168.56.10:9200/_cat/nodes?h=id,ip,port,v,m
Docs: Made current version, branch and jdk into asciidoc attributes
2014-07-23 05:54:53 -04:00
pLSN 192.168.56.30 9300 {version} m
k0zy 192.168.56.10 9300 {version} m
6Tyi 192.168.56.20 9300 {version} *
[DOCS] Update nodes documentation with all headers Adds a table with the exhaustive list of all available headers with a brief description (mostly from `org.elasticsearch.rest.action.cat.RestNodesAction`) so that people do not need to go searching for them in the code like I did, or search through `nodes?help`.
2014-03-27 01:19:54 -04:00
--------------------------------------------------
Docs: Made current version, branch and jdk into asciidoc attributes
2014-07-23 05:54:53 -04:00
[cols="<,<,<,<,<",options="header",subs="normal"]
[DOCS] Update nodes documentation with all headers Adds a table with the exhaustive list of all available headers with a brief description (mostly from `org.elasticsearch.rest.action.cat.RestNodesAction`) so that people do not need to go searching for them in the code like I did, or search through `nodes?help`.
2014-03-27 01:19:54 -04:00
|=======================================================================
|Header |Alias |Appear by Default |Description |Example
|`id` |`nodeId` |No |Unique node ID |k0zy
|`pid` |`p` |No |Process ID |13061
|`host` |`h` |Yes |Host name |n1
|`ip` |`i` |Yes |IP address |127.0.1.1
|`port` |`po` |No |Bound transport port |9300
Docs: Made current version, branch and jdk into asciidoc attributes
2014-07-23 05:54:53 -04:00
|`version` |`v` |No |Elasticsearch version |{version}
[DOCS] Update nodes documentation with all headers Adds a table with the exhaustive list of all available headers with a brief description (mostly from `org.elasticsearch.rest.action.cat.RestNodesAction`) so that people do not need to go searching for them in the code like I did, or search through `nodes?help`.
2014-03-27 01:19:54 -04:00
|`build` |`b` |No |Elasticsearch Build hash |5c03844
|`jdk` |`j` |No |Running Java version |1.8.0
|`disk.avail` |`d`, `disk`, `diskAvail` |No |Available disk space |1.8gb
Add file descriptor details to cat/nodes cat/nodes currently does not report any details related to file descriptors. This adds the current number in use, the maximum number available as well as their ratio (percentage) to cat/nodes as hidden-by-default metrics. In addition, this also adds current heap usage (as a non-percentage of ts max) and ram usage (as a non-percerntage of its max) to allow tools to provide more granularity. Closes #7652
2014-09-09 00:04:59 -04:00
|`heap.current` |`hc`, `heapCurrent` |No |Used heap |311.2mb
|`heap.percent` |`hp`, `heapPercent` |Yes |Used heap percentage |7
[DOCS] Update nodes documentation with all headers Adds a table with the exhaustive list of all available headers with a brief description (mostly from `org.elasticsearch.rest.action.cat.RestNodesAction`) so that people do not need to go searching for them in the code like I did, or search through `nodes?help`.
2014-03-27 01:19:54 -04:00
|`heap.max` |`hm`, `heapMax` |No |Maximum configured heap |1015.6mb
Add file descriptor details to cat/nodes cat/nodes currently does not report any details related to file descriptors. This adds the current number in use, the maximum number available as well as their ratio (percentage) to cat/nodes as hidden-by-default metrics. In addition, this also adds current heap usage (as a non-percentage of ts max) and ram usage (as a non-percerntage of its max) to allow tools to provide more granularity. Closes #7652
2014-09-09 00:04:59 -04:00
|`ram.current` |`rc`, `ramCurrent` |No |Used total memory |513.4mb
|`ram.percent` |`rp`, `ramPercent` |Yes |Used total memory percentage |47
[DOCS] Update nodes documentation with all headers Adds a table with the exhaustive list of all available headers with a brief description (mostly from `org.elasticsearch.rest.action.cat.RestNodesAction`) so that people do not need to go searching for them in the code like I did, or search through `nodes?help`.
2014-03-27 01:19:54 -04:00
|`ram.max` |`rm`, `ramMax` |No |Total memory |2.9gb
Add file descriptor details to cat/nodes cat/nodes currently does not report any details related to file descriptors. This adds the current number in use, the maximum number available as well as their ratio (percentage) to cat/nodes as hidden-by-default metrics. In addition, this also adds current heap usage (as a non-percentage of ts max) and ram usage (as a non-percerntage of its max) to allow tools to provide more granularity. Closes #7652
2014-09-09 00:04:59 -04:00
|`file_desc.current` |`fdc`, `fileDescriptorCurrent` |No |Used file
descriptors |123
|`file_desc.percent` |`fdp`, `fileDescriptorPercent` |Yes |Used file
descriptors percentage |1
|`file_desc.max` |`fdm`, `fileDescriptorMax` |No |Maximum number of file
descriptors |1024
[DOCS] Update nodes documentation with all headers Adds a table with the exhaustive list of all available headers with a brief description (mostly from `org.elasticsearch.rest.action.cat.RestNodesAction`) so that people do not need to go searching for them in the code like I did, or search through `nodes?help`.
2014-03-27 01:19:54 -04:00
|`load` |`l` |No |Most recent load average |0.22
|`uptime` |`u` |No |Node uptime |17.3m
|`node.role` |`r`, `role`, `dc`, `nodeRole` |Yes |Data node (d); Client
node (c) |d
|`master` |`m` |Yes |Current master (*); master eligible (m) |m
|`name` |`n` |Yes |Node name |Venom
|`completion.size` |`cs`, `completionSize` |No |Size of completion |0b
|`fielddata.memory_size` |`fm`, `fielddataMemory` |No |Used fielddata
cache memory |0b
|`fielddata.evictions` |`fe`, `fielddataEvictions` |No |Fielddata cache
evictions |0
|`filter_cache.memory_size` |`fcm`, `filterCacheMemory` |No |Used filter
cache memory |0b
|`filter_cache.evictions` |`fce`, `filterCacheEvictions` |No |Filter
cache evictions |0
|`flush.total` |`ft`, `flushTotal` |No |Number of flushes |1
|`flush.total_time` |`ftt`, `flushTotalTime` |No |Time spent in flush |1
|`get.current` |`gc`, `getCurrent` |No |Number of current get
operations |0
|`get.time` |`gti`, `getTime` |No |Time spent in get |14ms
|`get.total` |`gto`, `getTotal` |No |Number of get operations |2
|`get.exists_time` |`geti`, `getExistsTime` |No |Time spent in
successful gets |14ms
|`get.exists_total` |`geto`, `getExistsTotal` |No |Number of successful
get operations |2
|`get.missing_time` |`gmti`, `getMissingTime` |No |Time spent in failed
gets |0s
|`get.missing_total` |`gmto`, `getMissingTotal` |No |Number of failed
get operations |1
|`indexing.delete_current` |`idc`, `indexingDeleteCurrent` |No |Number
of current deletion operations |0
|`indexing.delete_time` |`idti`, `indexingDeleteTime` |No |Time spent in
deletions |2ms
|`indexing.delete_total` |`idto`, `indexingDeleteTotal` |No |Number of
deletion operations |2
|`indexing.index_current` |`iic`, `indexingIndexCurrent` |No |Number
of current indexing operations |0
|`indexing.index_time` |`iiti`, `indexingIndexTime` |No |Time spent in
indexing |134ms
|`indexing.index_total` |`iito`, `indexingIndexTotal` |No |Number of
indexing operations |1
|`merges.current` |`mc`, `mergesCurrent` |No |Number of current
merge operations |0
|`merges.current_docs` |`mcd`, `mergesCurrentDocs` |No |Number of
current merging documents |0
|`merges.current_size` |`mcs`, `mergesCurrentSize` |No |Size of current
merges |0b
|`merges.total` |`mt`, `mergesTotal` |No |Number of completed merge
operations |0
|`merges.total_docs` |`mtd`, `mergesTotalDocs` |No |Number of merged
documents |0
|`merges.total_size` |`mts`, `mergesTotalSize` |No |Size of current
merges |0b
|`merges.total_time` |`mtt`, `mergesTotalTime` |No |Time spent merging
documents |0s
|`percolate.current` |`pc`, `percolateCurrent` |No |Number of current
percolations |0
|`percolate.memory_size` |`pm`, `percolateMemory` |No |Memory used by
current percolations |0b
|`percolate.queries` |`pq`, `percolateQueries` |No |Number of
registered percolation queries |0
|`percolate.time` |`pti`, `percolateTime` |No |Time spent
percolating |0s
|`percolate.total` |`pto`, `percolateTotal` |No |Total percolations |0
|`refresh.total` |`rto`, `refreshTotal` |No |Number of refreshes |16
|`refresh.time` |`rti`, `refreshTime` |No |Time spent in refreshes |91ms
|`search.fetch_current` |`sfc`, `searchFetchCurrent` |No |Current fetch
phase operations |0
|`search.fetch_time` |`sfti`, `searchFetchTime` |No |Time spent in fetch
phase |37ms
|`search.fetch_total` |`sfto`, `searchFetchTotal` |No |Number of fetch
operations |7
|`search.open_contexts` |`so`, `searchOpenContexts` |No |Open search
contexts |0
|`search.query_current` |`sqc`, `searchFetchCurrent` |No |Current query
phase operations |0
|`search.query_time` |`sqti`, `searchFetchTime` |No |Time spent in query
phase |43ms
|`search.query_total` |`sqto`, `searchFetchTotal` |No |Number of query
operations |9
Add scroll stats to cat API Adds scroll stats at the node, shard and index levels to the cat API. Closes #12330
2015-07-19 13:41:46 -04:00
|`search.scroll_current` |`scc`, `searchScrollCurrent` |No |Open scroll contexts |2
|`search.scroll_time` |`scti`, `searchScrollTime` |No |Time scroll contexts held open|2m
|`search.scroll_total` |`scto`, `searchScrollTotal` |No |Completed scroll contexts |1
[DOCS] Update nodes documentation with all headers Adds a table with the exhaustive list of all available headers with a brief description (mostly from `org.elasticsearch.rest.action.cat.RestNodesAction`) so that people do not need to go searching for them in the code like I did, or search through `nodes?help`.
2014-03-27 01:19:54 -04:00
|`segments.count` |`sc`, `segmentsCount` |No |Number of segments |4
|`segments.memory` |`sm`, `segmentsMemory` |No |Memory used by
segments |1.4kb
Stats: Expose IndexWriter and VersionMap RAM usage to ShardStats and _cat endpoint This commit adds the RAM usage of IndexWriter and VersionMap Closes #6483
2014-07-11 17:07:38 -04:00
|`segments.index_writer_memory` |`siwm`, `segmentsIndexWriterMemory` |No
Stats: add segments.index_writer_max_memory to see index writer's max RAM usage before buffered documents must be written to a new segment Closes #7438 Closes #7440
2014-08-25 14:43:09 -04:00
|Memory used by index writer |18mb
|`segments.index_writer_max_memory` |`siwmx`, `segmentsIndexWriterMaxMemory` |No
|Maximum memory index writer may use before it must write buffered documents to a new segment |32mb
Stats: Expose IndexWriter and VersionMap RAM usage to ShardStats and _cat endpoint This commit adds the RAM usage of IndexWriter and VersionMap Closes #6483
2014-07-11 17:07:38 -04:00
|`segments.version_map_memory` |`svmm`, `segmentsVersionMapMemory` |No
|Memory used by version map |1.0kb
[DOCS] Update nodes documentation with all headers Adds a table with the exhaustive list of all available headers with a brief description (mostly from `org.elasticsearch.rest.action.cat.RestNodesAction`) so that people do not need to go searching for them in the code like I did, or search through `nodes?help`.
2014-03-27 01:19:54 -04:00
|=======================================================================