Skip to content

Commit 92d7bbe

Browse files
authored
[DOCS] Document dynamic circuit breaker settings (#61334) (#61336)
1 parent 42f696f commit 92d7bbe

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/reference/modules/indices/circuit_breaker.asciidoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ live cluster with the <<cluster-update-settings,cluster-update-settings>> API.
1515
The parent-level breaker can be configured with the following settings:
1616

1717
`indices.breaker.total.use_real_memory`::
18-
19-
_Static_ setting determining whether the parent breaker should take real
18+
(<<static-cluster-setting,Static>>)
19+
Determines whether the parent breaker should take real
2020
memory usage into account (`true`) or only consider the amount that is
2121
reserved by child circuit breakers (`false`). Defaults to `true`.
2222

2323
[[indices-breaker-total-limit]]
2424
// tag::indices-breaker-total-limit-tag[]
2525
`indices.breaker.total.limit` {ess-icon}::
26-
26+
(<<dynamic-cluster-setting,Dynamic>>)
2727
Starting limit for overall parent breaker. Defaults to 70% of JVM heap if
2828
`indices.breaker.total.use_real_memory` is `false`. If `indices.breaker.total.use_real_memory`
2929
is `true`, defaults to 95% of the JVM heap.
@@ -41,14 +41,14 @@ parameters:
4141
[[fielddata-circuit-breaker-limit]]
4242
// tag::fielddata-circuit-breaker-limit-tag[]
4343
`indices.breaker.fielddata.limit` {ess-icon}::
44-
44+
(<<dynamic-cluster-setting,Dynamic>>)
4545
Limit for fielddata breaker. Defaults to 40% of JVM heap.
4646
// end::fielddata-circuit-breaker-limit-tag[]
4747

4848
[[fielddata-circuit-breaker-overhead]]
4949
// tag::fielddata-circuit-breaker-overhead-tag[]
5050
`indices.breaker.fielddata.overhead` {ess-icon}::
51-
51+
(<<dynamic-cluster-setting,Dynamic>>)
5252
A constant that all field data estimations are multiplied with to determine a
5353
final estimation. Defaults to `1.03`.
5454
// end::fielddata-circuit-breaker-overhead-tag[]
@@ -64,14 +64,14 @@ request) from exceeding a certain amount of memory.
6464
[[request-breaker-limit]]
6565
// tag::request-breaker-limit-tag[]
6666
`indices.breaker.request.limit` {ess-icon}::
67-
67+
(<<dynamic-cluster-setting,Dynamic>>)
6868
Limit for request breaker, defaults to 60% of JVM heap.
6969
// end::request-breaker-limit-tag[]
7070

7171
[[request-breaker-overhead]]
7272
// tag::request-breaker-overhead-tag[]
7373
`indices.breaker.request.overhead` {ess-icon}::
74-
74+
(<<dynamic-cluster-setting,Dynamic>>)
7575
A constant that all request estimations are multiplied with to determine a
7676
final estimation. Defaults to `1`.
7777
// end::request-breaker-overhead-tag[]
@@ -87,12 +87,12 @@ circuit breaker also considers that memory is not only needed for representing t
8787
also as a structured object which is reflected by default overhead.
8888

8989
`network.breaker.inflight_requests.limit`::
90-
90+
(<<dynamic-cluster-setting,Dynamic>>)
9191
Limit for in flight requests breaker, defaults to 100% of JVM heap. This means that it is bound
9292
by the limit configured for the parent circuit breaker.
9393

9494
`network.breaker.inflight_requests.overhead`::
95-
95+
(<<dynamic-cluster-setting,Dynamic>>)
9696
A constant that all in flight requests estimations are multiplied with to determine a
9797
final estimation. Defaults to 2.
9898

@@ -105,12 +105,12 @@ usage of things held in memory that are not released when a request is
105105
completed. This includes things like the Lucene segment memory.
106106

107107
`indices.breaker.accounting.limit`::
108-
108+
(<<dynamic-cluster-setting,Dynamic>>)
109109
Limit for accounting breaker, defaults to 100% of JVM heap. This means that it is bound
110110
by the limit configured for the parent circuit breaker.
111111

112112
`indices.breaker.accounting.overhead`::
113-
113+
(<<dynamic-cluster-setting,Dynamic>>)
114114
A constant that all accounting estimations are multiplied with to determine a
115115
final estimation. Defaults to 1
116116

@@ -126,7 +126,7 @@ See the "prefer-parameters" section of the <<modules-scripting-using,scripting>>
126126
documentation for more information.
127127

128128
`script.context.$CONTEXT.max_compilations_rate`::
129-
129+
(<<dynamic-cluster-setting,Dynamic>>)
130130
Limit for the number of unique dynamic scripts within a certain interval
131131
that are allowed to be compiled for a given context. Defaults to `75/5m`,
132132
meaning 75 every 5 minutes.

0 commit comments

Comments
 (0)