diff --git a/docs/reference/eql/eql.asciidoc b/docs/reference/eql/eql.asciidoc index 940d069b4db5..025a72f0fe95 100644 --- a/docs/reference/eql/eql.asciidoc +++ b/docs/reference/eql/eql.asciidoc @@ -849,40 +849,7 @@ GET /cluster_one:my-data-stream,cluster_two:my-data-stream/_eql/search [[eql-circuit-breaker]] === EQL circuit breaker settings -When a <> query is executed, the node handling the query -needs to keep some structures in memory, which are needed by the algorithm -implementing the sequence matching. When large amounts of data need to be processed, -and/or a large amount of matched sequences is requested by the user (by setting the -<> query param), the memory occupied by those -structures could potentially exceed the available memory of the JVM. This would cause -an `OutOfMemory` exception which would bring down the node. - -To prevent this from happening, a special <> is used, -which limits the memory allocation during the execution of a <> -query. When the breaker is triggered, an `org.elasticsearch.common.breaker.CircuitBreakingException` -is thrown and a descriptive error message is returned to the user. - -This <> can be configured using the following settings: - -`breaker.eql_sequence.limit`:: -(<>) The limit for circuit breaker used to restrict -the memory utilisation during the execution of an EQL sequence query. This value is -defined as a percentage of the JVM heap. Defaults to `50%`. If the -<> is set to a value less than `50%`, -this setting uses that value as its default instead. - -`breaker.eql_sequence.overhead`:: -(<>) A constant that sequence query memory -estimates are multiplied by to determine a final estimate. Defaults to `1`. - -`breaker.eql_sequence.type`:: -(<>) Circuit breaker type. Valid values are: - -`memory` (Default)::: -The breaker limits memory usage for EQL sequence queries. - -`noop`::: -Disables the breaker. +The relevant circuit breaker settings can be found in the <>. include::syntax.asciidoc[] include::functions.asciidoc[] diff --git a/docs/reference/modules/indices/circuit_breaker.asciidoc b/docs/reference/modules/indices/circuit_breaker.asciidoc index d04f531e1459..caa6c43d45a9 100644 --- a/docs/reference/modules/indices/circuit_breaker.asciidoc +++ b/docs/reference/modules/indices/circuit_breaker.asciidoc @@ -177,3 +177,64 @@ it triggers the regex circuit breaker and returns an error. + {es} only applies this limit if <> is `limited`. + +[[circuit-breakers-page-eql]] +[discrete] +=== EQL circuit breaker + +When a <> query is executed, the node handling the query +needs to keep some structures in memory, which are needed by the algorithm +implementing the sequence matching. When large amounts of data need to be processed, +and/or a large amount of matched sequences is requested by the user (by setting the +<> query param), the memory occupied by those +structures could potentially exceed the available memory of the JVM. This would cause +an `OutOfMemory` exception which would bring down the node. + +To prevent this from happening, a special <> is used, +which limits the memory allocation during the execution of a <> +query. When the breaker is triggered, an `org.elasticsearch.common.breaker.CircuitBreakingException` +is thrown and a descriptive error message is returned to the user. + +This <> can be configured using the following settings: + +`breaker.eql_sequence.limit`:: +(<>) The limit for circuit breaker used to restrict +the memory utilisation during the execution of an EQL sequence query. This value is +defined as a percentage of the JVM heap. Defaults to `50%`. If the +<> is set to a value less than `50%`, +this setting uses that value as its default instead. + +`breaker.eql_sequence.overhead`:: +(<>) A constant that sequence query memory +estimates are multiplied by to determine a final estimate. Defaults to `1`. + +`breaker.eql_sequence.type`:: +(<>) Circuit breaker type. Valid values are: + +`memory` (Default)::: +The breaker limits memory usage for EQL sequence queries. + +`noop`::: +Disables the breaker. + +[[circuit-breakers-page-model-inference]] +[discrete] +==== {ml-cap} circuit breaker + +`breaker.model_inference.limit`:: +(<>) The limit for the trained model circuit +breaker. This value is defined as a percentage of the JVM heap. Defaults to +`50%`. If the <> is set to a +value less than `50%`, this setting uses that value as its default instead. + +`breaker.model_inference.overhead`:: +(<>) A constant that all trained model +estimations are multiplied by to determine a final estimation. See +<>. Defaults to `1`. + +`breaker.model_inference.type`:: +(<>) The underlying type of the circuit breaker. +There are two valid options: `noop` and `memory`. `noop` means the circuit +breaker does nothing to prevent too much memory usage. `memory` means the +circuit breaker tracks the memory used by trained models and can potentially +break and prevent `OutOfMemory` errors. The default value is `memory`. diff --git a/docs/reference/settings/ml-settings.asciidoc b/docs/reference/settings/ml-settings.asciidoc index c12745455f32..39cb492da8b8 100644 --- a/docs/reference/settings/ml-settings.asciidoc +++ b/docs/reference/settings/ml-settings.asciidoc @@ -220,20 +220,5 @@ defaults to the largest size that could be assigned in the current cluster. [[model-inference-circuit-breaker]] ==== {ml-cap} circuit breaker settings -`breaker.model_inference.limit`:: -(<>) The limit for the trained model circuit -breaker. This value is defined as a percentage of the JVM heap. Defaults to -`50%`. If the <> is set to a -value less than `50%`, this setting uses that value as its default instead. +The relevant circuit breaker settings can be found in the <>. -`breaker.model_inference.overhead`:: -(<>) A constant that all trained model -estimations are multiplied by to determine a final estimation. See -<>. Defaults to `1`. - -`breaker.model_inference.type`:: -(<>) The underlying type of the circuit breaker. -There are two valid options: `noop` and `memory`. `noop` means the circuit -breaker does nothing to prevent too much memory usage. `memory` means the -circuit breaker tracks the memory used by trained models and can potentially -break and prevent `OutOfMemory` errors. The default value is `memory`.