Skip to content

Commit ffa8224

Browse files
authored
Add note about incompleteness of CBs (#116176) (#116187)
The docs kinda imply that circuit breakers protect against OOMEs, at least that's how some customers seem to interpret them. This commit adds a note spelling out that this isn't the case.
1 parent 04736f8 commit ffa8224

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/reference/modules/indices/circuit_breaker.asciidoc

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,16 @@
22
=== Circuit breaker settings
33
[[circuit-breaker-description]]
44
// tag::circuit-breaker-description-tag[]
5-
{es} contains multiple circuit breakers used to prevent operations from causing an OutOfMemoryError. Each breaker specifies a limit for how much memory it can use. Additionally, there is a parent-level breaker that specifies the total amount of memory that can be used across all breakers.
5+
{es} contains multiple circuit breakers used to prevent operations from using an excessive amount of memory. Each breaker tracks the memory
6+
used by certain operations and specifies a limit for how much memory it may track. Additionally, there
7+
is a parent-level breaker that specifies the total amount of memory that may be tracked across all breakers.
8+
9+
When a circuit breaker reaches its limit, {es} will reject further operations. See <<circuit-breaker-errors>> for information about errors
10+
raised by circuit breakers.
11+
12+
Circuit breakers do not track all memory usage in {es} and therefore provide only incomplete protection against excessive memory usage. If
13+
{es} uses too much memory then it may suffer from performance issues and nodes may even fail with an `OutOfMemoryError`. See
14+
<<high-jvm-memory-pressure>> for help with troubleshooting high heap usage.
615

716
Except where noted otherwise, these settings can be dynamically updated on a
817
live cluster with the <<cluster-update-settings,cluster-update-settings>> API.

0 commit comments

Comments
 (0)