Skip to content

Commit aead0f0

Browse files
committed
[DOCS] Document breakers, script, and discovery node stats (#50509)
Documents the `breakers`, `script`, and `discovery` parameters returned by the `_nodes/stats` API.
1 parent c5b26bf commit aead0f0

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

docs/reference/cluster/nodes-stats.asciidoc

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -960,6 +960,78 @@ Current number of open HTTP connections for the node.
960960
(integer)
961961
Total number of HTTP connections opened for the node.
962962

963+
[[cluster-nodes-stats-api-response-body-breakers]]
964+
===== `breakers` section
965+
966+
`breakers.<circuit_breaker_name>.limit_size_in_bytes`::
967+
(integer)
968+
Memory limit, in bytes, for the circuit breaker.
969+
970+
`breakers.<circuit_breaker_name>.limit_size`::
971+
(<<byte-units,byte value>>)
972+
Memory limit for the circuit breaker.
973+
974+
`breakers.<circuit_breaker_name>.estimated_size_in_bytes`::
975+
(integer)
976+
Estimated memory used, in bytes, for the operation.
977+
978+
`breakers.<circuit_breaker_name>.estimated_size`::
979+
(<<byte-units,byte value>>)
980+
Estimated memory used for the operation.
981+
982+
`breakers.<circuit_breaker_name>.overhead`::
983+
(float)
984+
A constant that all estimates for the circuit breaker are multiplied with to
985+
calculate a final estimate.
986+
987+
`breakers.<circuit_breaker_name>.tripped`::
988+
(integer)
989+
Total number of times the circuit breaker has been triggered and prevented an
990+
out of memory error.
991+
992+
[[cluster-nodes-stats-api-response-body-script]]
993+
===== `script` section
994+
995+
`script.compilations`::
996+
(integer)
997+
Total number of inline script compilations performed by the node.
998+
999+
`script.cache_evictions`::
1000+
(integer)
1001+
Total number of times the script cache has evicted old data.
1002+
1003+
`script.compilation_limit_triggered`::
1004+
(integer)
1005+
Total number of times the <<script-compilation-circuit-breaker,script
1006+
compilation>> circuit breaker has limited inline script compilations.
1007+
1008+
[[cluster-nodes-stats-api-response-body-discovery]]
1009+
===== `discovery` section
1010+
1011+
`discovery.cluster_state_queue.total`::
1012+
(integer)
1013+
Total number of cluster states in queue.
1014+
1015+
`discovery.cluster_state_queue.pending`::
1016+
(integer)
1017+
Number of pending cluster states in queue.
1018+
1019+
`discovery.cluster_state_queue.committed`::
1020+
(integer)
1021+
Number of committed cluster states in queue.
1022+
1023+
`discovery.published_cluster_states.full_states`::
1024+
(integer)
1025+
Number of published cluster states.
1026+
1027+
`discovery.published_cluster_states.incompatible_diffs`::
1028+
(integer)
1029+
Number of incompatible differences between published cluster states.
1030+
1031+
`discovery.published_cluster_states.compatible_diffs`::
1032+
(integer)
1033+
Number of compatible differences between published cluster states.
1034+
9631035
[[cluster-nodes-stats-api-response-body-ingest]]
9641036
===== `ingest` section
9651037

0 commit comments

Comments
 (0)