[DOCS] Document dynamic circuit breaker settings (#61334) (#61335)

This commit is contained in:
James Rodewig 2020-08-19 11:13:46 -04:00 committed by GitHub
parent 128d66b03e
commit dc9d613280
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions

View File

@ -15,15 +15,15 @@ live cluster with the <<cluster-update-settings,cluster-update-settings>> API.
The parent-level breaker can be configured with the following settings:
`indices.breaker.total.use_real_memory`::
_Static_ setting determining whether the parent breaker should take real
(<<static-cluster-setting,Static>>)
Determines whether the parent breaker should take real
memory usage into account (`true`) or only consider the amount that is
reserved by child circuit breakers (`false`). Defaults to `true`.
[[indices-breaker-total-limit]]
// tag::indices-breaker-total-limit-tag[]
`indices.breaker.total.limit` {ess-icon}::
(<<dynamic-cluster-setting,Dynamic>>)
Starting limit for overall parent breaker. Defaults to 70% of JVM heap if
`indices.breaker.total.use_real_memory` is `false`. If `indices.breaker.total.use_real_memory`
is `true`, defaults to 95% of the JVM heap.
@ -41,14 +41,14 @@ parameters:
[[fielddata-circuit-breaker-limit]]
// tag::fielddata-circuit-breaker-limit-tag[]
`indices.breaker.fielddata.limit` {ess-icon}::
(<<dynamic-cluster-setting,Dynamic>>)
Limit for fielddata breaker. Defaults to 40% of JVM heap.
// end::fielddata-circuit-breaker-limit-tag[]
[[fielddata-circuit-breaker-overhead]]
// tag::fielddata-circuit-breaker-overhead-tag[]
`indices.breaker.fielddata.overhead` {ess-icon}::
(<<dynamic-cluster-setting,Dynamic>>)
A constant that all field data estimations are multiplied with to determine a
final estimation. Defaults to `1.03`.
// end::fielddata-circuit-breaker-overhead-tag[]
@ -64,14 +64,14 @@ request) from exceeding a certain amount of memory.
[[request-breaker-limit]]
// tag::request-breaker-limit-tag[]
`indices.breaker.request.limit` {ess-icon}::
(<<dynamic-cluster-setting,Dynamic>>)
Limit for request breaker, defaults to 60% of JVM heap.
// end::request-breaker-limit-tag[]
[[request-breaker-overhead]]
// tag::request-breaker-overhead-tag[]
`indices.breaker.request.overhead` {ess-icon}::
(<<dynamic-cluster-setting,Dynamic>>)
A constant that all request estimations are multiplied with to determine a
final estimation. Defaults to `1`.
// end::request-breaker-overhead-tag[]
@ -87,12 +87,12 @@ circuit breaker also considers that memory is not only needed for representing t
also as a structured object which is reflected by default overhead.
`network.breaker.inflight_requests.limit`::
(<<dynamic-cluster-setting,Dynamic>>)
Limit for in flight requests breaker, defaults to 100% of JVM heap. This means that it is bound
by the limit configured for the parent circuit breaker.
`network.breaker.inflight_requests.overhead`::
(<<dynamic-cluster-setting,Dynamic>>)
A constant that all in flight requests estimations are multiplied with to determine a
final estimation. Defaults to 2.
@ -105,12 +105,12 @@ usage of things held in memory that are not released when a request is
completed. This includes things like the Lucene segment memory.
`indices.breaker.accounting.limit`::
(<<dynamic-cluster-setting,Dynamic>>)
Limit for accounting breaker, defaults to 100% of JVM heap. This means that it is bound
by the limit configured for the parent circuit breaker.
`indices.breaker.accounting.overhead`::
(<<dynamic-cluster-setting,Dynamic>>)
A constant that all accounting estimations are multiplied with to determine a
final estimation. Defaults to 1
@ -126,7 +126,7 @@ See the "prefer-parameters" section of the <<modules-scripting-using,scripting>>
documentation for more information.
`script.context.$CONTEXT.max_compilations_rate`::
(<<dynamic-cluster-setting,Dynamic>>)
Limit for the number of unique dynamic scripts within a certain interval
that are allowed to be compiled for a given context. Defaults to `75/5m`,
meaning 75 every 5 minutes.