From dc9d613280de107333ea0691cf0efab669c91c0e Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Wed, 19 Aug 2020 11:13:46 -0400 Subject: [PATCH] [DOCS] Document dynamic circuit breaker settings (#61334) (#61335) --- .../modules/indices/circuit_breaker.asciidoc | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/reference/modules/indices/circuit_breaker.asciidoc b/docs/reference/modules/indices/circuit_breaker.asciidoc index 92ad22b38d3..d06b3f27c11 100644 --- a/docs/reference/modules/indices/circuit_breaker.asciidoc +++ b/docs/reference/modules/indices/circuit_breaker.asciidoc @@ -15,15 +15,15 @@ live cluster with the <> 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 + (<>) + 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}:: - + (<>) 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}:: - + (<>) 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}:: - + (<>) 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}:: - + (<>) 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}:: - + (<>) 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`:: - + (<>) 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`:: - + (<>) 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`:: - + (<>) 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`:: - + (<>) 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 <> documentation for more information. `script.context.$CONTEXT.max_compilations_rate`:: - + (<>) 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.