Skip to content

Commit 1545c2a

Browse files
committed
[DOCS] Document node stats response meta (#51263)
Documents several metadata-related parameters returned by the `GET _nodes/stats` API.
1 parent 1800b27 commit 1545c2a

File tree

2 files changed

+42
-4
lines changed

2 files changed

+42
-4
lines changed

docs/reference/cluster/nodes-stats.asciidoc

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,45 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes]
137137
[[cluster-nodes-stats-api-response-body]]
138138
==== {api-response-body-title}
139139

140+
`cluster_name`::
141+
(string)
142+
Name of the cluster. Based on the <<cluster.name>> setting.
143+
144+
`nodes.<node_id>.timestamp`::
145+
(integer)
146+
Time the node stats were collected for this response. Recorded in milliseconds
147+
since the https://en.wikipedia.org/wiki/Unix_time[Unix Epoch].
148+
149+
`nodes.<node_id>.name`::
150+
(string)
151+
Human-readable identifier for the node. Based on the <<node.name>> setting.
152+
153+
`nodes.<node_id>.transport_address`::
154+
(string)
155+
Host and port for the <<modules-transport,transport layer>>, used for internal
156+
communication between nodes in a cluster.
157+
158+
`nodes.<node_id>.host`::
159+
(string)
160+
Network host for the node, based on the <<network.host>> setting.
161+
162+
`nodes.<node_id>.ip`::
163+
(string)
164+
IP address and port for the node.
165+
166+
`nodes.<node_id>.roles`::
167+
(array of strings)
168+
Roles assigned to the node. See <<modules-node>>.
169+
170+
`nodes.<node_id>.attributes`::
171+
(object)
172+
Object containing a list of attributes for the node.
173+
174+
[NOTE]
175+
====
176+
The remaining node statistics are grouped by section. Each statistic is keyed by `nodes.<node_id>`.
177+
====
178+
140179
[[cluster-nodes-stats-api-response-body-indices]]
141180
===== `indices` section
142181

@@ -475,8 +514,8 @@ for <<parent-join,join>> fields.
475514
476515
`indices.segments.max_unsafe_auto_id_timestamp`::
477516
(integer)
478-
Timestamp of the
479-
most recent retry request.
517+
Time of the most recently retried indexing request. Recorded in milliseconds
518+
since the https://en.wikipedia.org/wiki/Unix_time[Unix Epoch].
480519
481520
`indices.segments.file_sizes.size_in_bytes`::
482521
(integer)
@@ -1120,8 +1159,6 @@ Number of compatible differences between published cluster states.
11201159

11211160
[%collapsible]
11221161
====
1123-
The `adaptive_selection` statistics are keyed by node. For each node:
1124-
11251162
`adaptive_selection.outgoing_searches`::
11261163
The number of outstanding search requests from the node these stats are for
11271164
to the keyed node.

docs/reference/settings/ml-settings.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ that is greater than this setting value, an error occurs. Existing jobs are not
8383
affected when you update this setting. For more information about the
8484
`model_memory_limit` property, see <<put-analysislimits>>.
8585

86+
[[xpack.ml.max_open_jobs]]
8687
`xpack.ml.max_open_jobs` (<<cluster-update-settings,Dynamic>>)::
8788
The maximum number of jobs that can run simultaneously on a node. Defaults to
8889
`20`. In this context, jobs include both {anomaly-jobs} and {dfanalytics-jobs}.

0 commit comments

Comments
 (0)