Skip to content

Commit 1f23fc7

Browse files
Clarify which circuit breaker settings are static (#44992)
Most of the circuit breaker settings are dynamically configurable. However, `indices.breaker.total.use_real_memory` is not. With this commit we add a clarifying note that this specific setting is static. Closes #44974
1 parent 3e7df14 commit 1f23fc7

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/reference/modules/indices/circuit_breaker.asciidoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ causing an OutOfMemoryError. Each breaker specifies a limit for how much memory
66
it can use. Additionally, there is a parent-level breaker that specifies the
77
total amount of memory that can be used across all breakers.
88

9-
These settings can be dynamically updated on a live cluster with the
10-
<<cluster-update-settings,cluster-update-settings>> API.
9+
Except where noted otherwise, these settings can be dynamically updated on a
10+
live cluster with the <<cluster-update-settings,cluster-update-settings>> API.
1111

1212
[[parent-circuit-breaker]]
1313
[float]
@@ -17,8 +17,9 @@ The parent-level breaker can be configured with the following settings:
1717

1818
`indices.breaker.total.use_real_memory`::
1919

20-
Whether the parent breaker should take real memory usage into account (`true`) or only
21-
consider the amount that is reserved by child circuit breakers (`false`). Defaults to `true`.
20+
_Static_ setting determining whether the parent breaker should take real
21+
memory usage into account (`true`) or only consider the amount that is
22+
reserved by child circuit breakers (`false`). Defaults to `true`.
2223

2324
`indices.breaker.total.limit`::
2425

0 commit comments

Comments
 (0)