From a290762df1ec18feb4399b0451f76a7e9d43a11d Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Tue, 14 Jan 2020 16:48:35 -0500 Subject: [PATCH] [DOCS] Document `breakers`, `script`, and `discovery` node stats (#50509) Documents the `breakers`, `script`, and `discovery` parameters returned by the `_nodes/stats` API. --- docs/reference/cluster/nodes-stats.asciidoc | 72 +++++++++++++++++++++ 1 file changed, 72 insertions(+) diff --git a/docs/reference/cluster/nodes-stats.asciidoc b/docs/reference/cluster/nodes-stats.asciidoc index 9306c23e43f..ed04e1b0855 100644 --- a/docs/reference/cluster/nodes-stats.asciidoc +++ b/docs/reference/cluster/nodes-stats.asciidoc @@ -960,6 +960,78 @@ Current number of open HTTP connections for the node. (integer) Total number of HTTP connections opened for the node. +[[cluster-nodes-stats-api-response-body-breakers]] +===== `breakers` section + +`breakers..limit_size_in_bytes`:: +(integer) +Memory limit, in bytes, for the circuit breaker. + +`breakers..limit_size`:: +(<>) +Memory limit for the circuit breaker. + +`breakers..estimated_size_in_bytes`:: +(integer) +Estimated memory used, in bytes, for the operation. + +`breakers..estimated_size`:: +(<>) +Estimated memory used for the operation. + +`breakers..overhead`:: +(float) +A constant that all estimates for the circuit breaker are multiplied with to +calculate a final estimate. + +`breakers..tripped`:: +(integer) +Total number of times the circuit breaker has been triggered and prevented an +out of memory error. + +[[cluster-nodes-stats-api-response-body-script]] +===== `script` section + +`script.compilations`:: +(integer) +Total number of inline script compilations performed by the node. + +`script.cache_evictions`:: +(integer) +Total number of times the script cache has evicted old data. + +`script.compilation_limit_triggered`:: +(integer) +Total number of times the <> circuit breaker has limited inline script compilations. + +[[cluster-nodes-stats-api-response-body-discovery]] +===== `discovery` section + +`discovery.cluster_state_queue.total`:: +(integer) +Total number of cluster states in queue. + +`discovery.cluster_state_queue.pending`:: +(integer) +Number of pending cluster states in queue. + +`discovery.cluster_state_queue.committed`:: +(integer) +Number of committed cluster states in queue. + +`discovery.published_cluster_states.full_states`:: +(integer) +Number of published cluster states. + +`discovery.published_cluster_states.incompatible_diffs`:: +(integer) +Number of incompatible differences between published cluster states. + +`discovery.published_cluster_states.compatible_diffs`:: +(integer) +Number of compatible differences between published cluster states. + [[cluster-nodes-stats-api-response-body-ingest]] ===== `ingest` section