Added check_interval to the documentation. Changed the default value …

…to 500ms from 1s. Signed-off-by: David Venable <[email protected]>
opensearch-project · Jan 23, 2023 · 1a91082 · 1a91082
1 parent 1784729
commit 1a91082
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/...-core/src/main/java/org/opensearch/dataprepper/parser/model/HeapCircuitBreakerConfig.java b/...-core/src/main/java/org/opensearch/dataprepper/parser/model/HeapCircuitBreakerConfig.java
@@ -16,7 +16,7 @@
  */
 public class HeapCircuitBreakerConfig {
     public static final Duration DEFAULT_RESET = Duration.ofSeconds(1);
-    private static final Duration DEFAULT_CHECK_INTERVAL = Duration.ofSeconds(1);
+    private static final Duration DEFAULT_CHECK_INTERVAL = Duration.ofMillis(500);
     @NotNull
     @JsonProperty("usage")
     private ByteCount usage;

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -165,7 +165,8 @@ circuit_breakers:
 ```
 
 * `usage` - float - The absolute value of JVM memory which will trip the circuit breaker. This can be defined with bytes (`b`), kilobytes (`kb`), megabytes (`mb`), or gigabytes (`gb`).
-* `reset` - Duration - The time between when the circuit is tripped and the next attempt to validate will occur.
+* `reset` - Duration - The time between when the circuit is tripped and the next attempt to validate will occur. Defaults to 1s.
+* `check_interval` - Duration - The time between checks of the heap usage. Defaults to 500ms.
 
 ## Deprecated Pipeline Configuration Support
 Starting in Data Prepper 1.3.0, Prepper plugins were renamed to Processors. The use of the prepper or processor name in pipeline configuration files is still supported. However, the use of both processor and prepper in the same configuration file is **not** supported.