Class Resilience4jConfigurationCommon
- Direct Known Subclasses:
Resilience4jConfigurationDefinition
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
setAutomaticTransitionFromOpenToHalfOpenEnabled
(String automaticTransitionFromOpenToHalfOpenEnabled) Enables automatic transition from OPEN to HALF_OPEN state once the waitDurationInOpenState has passed.void
setBulkheadEnabled
(String bulkheadEnabled) Whether bulkhead is enabled or not on the circuit breaker.void
setBulkheadMaxConcurrentCalls
(String bulkheadMaxConcurrentCalls) Configures the max amount of concurrent calls the bulkhead will support.void
setBulkheadMaxWaitDuration
(String bulkheadMaxWaitDuration) Configures a maximum amount of time which the calling thread will wait to enter the bulkhead.void
setCircuitBreaker
(String circuitBreaker) Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreaker instance to lookup and use from the registry.void
Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreakerConfig instance to lookup and use from the registry.void
setFailureRateThreshold
(String failureRateThreshold) Configures the failure rate threshold in percentage.void
setMinimumNumberOfCalls
(String minimumNumberOfCalls) Configures the minimum number of calls which are required (per sliding window period) before the CircuitBreaker can calculate the error rate.void
setPermittedNumberOfCallsInHalfOpenState
(String permittedNumberOfCallsInHalfOpenState) Configures the number of permitted calls when the CircuitBreaker is half open.void
setSlidingWindowSize
(String slidingWindowSize) Configures the size of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed.void
setSlidingWindowType
(String slidingWindowType) Configures the type of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed.void
setSlowCallDurationThreshold
(String slowCallDurationThreshold) Configures the duration threshold (seconds) above which calls are considered as slow and increase the slow calls percentage.void
setSlowCallRateThreshold
(String slowCallRateThreshold) Configures a threshold in percentage.void
setThrowExceptionWhenHalfOpenOrOpenState
(String throwExceptionWhenHalfOpenOrOpenState) Whether to throw io.github.resilience4j.circuitbreaker.CallNotPermittedException when the call is rejected due circuit breaker is half open or open.void
setTimeoutCancelRunningFuture
(String timeoutCancelRunningFuture) Configures whether cancel is called on the running future.void
setTimeoutDuration
(String timeoutDuration) Configures the thread execution timeout.void
setTimeoutEnabled
(String timeoutEnabled) Whether timeout is enabled or not on the circuit breaker.void
setTimeoutExecutorService
(String timeoutExecutorService) References to a custom thread pool to use when timeout is enabled (usesForkJoinPool.commonPool()
by default)void
setWaitDurationInOpenState
(String waitDurationInOpenState) Configures the wait duration (in seconds) which specifies how long the CircuitBreaker should stay open, before it switches to half open.void
setWritableStackTraceEnabled
(String writableStackTraceEnabled) Enables writable stack traces.Methods inherited from class org.apache.camel.model.IdentifiedType
getId, setId
-
Constructor Details
-
Resilience4jConfigurationCommon
public Resilience4jConfigurationCommon()
-
-
Method Details
-
getCircuitBreaker
-
setCircuitBreaker
Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreaker instance to lookup and use from the registry. When using this, then any other circuit breaker options are not in use. -
getConfig
-
setConfig
Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreakerConfig instance to lookup and use from the registry. -
getFailureRateThreshold
-
setFailureRateThreshold
Configures the failure rate threshold in percentage. If the failure rate is equal or greater than the threshold the CircuitBreaker transitions to open and starts short-circuiting calls.The threshold must be greater than 0 and not greater than 100. Default value is 50 percentage.
-
getPermittedNumberOfCallsInHalfOpenState
-
setPermittedNumberOfCallsInHalfOpenState
Configures the number of permitted calls when the CircuitBreaker is half open.The size must be greater than 0. Default size is 10.
-
getThrowExceptionWhenHalfOpenOrOpenState
-
setThrowExceptionWhenHalfOpenOrOpenState
Whether to throw io.github.resilience4j.circuitbreaker.CallNotPermittedException when the call is rejected due circuit breaker is half open or open. -
getSlidingWindowSize
-
setSlidingWindowSize
Configures the size of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed.slidingWindowSize
configures the size of the sliding window. Sliding window can either be count-based or time-based. IfslidingWindowType
is COUNT_BASED, the lastslidingWindowSize
calls are recorded and aggregated. IfslidingWindowType
is TIME_BASED, the calls of the lastslidingWindowSize
seconds are recorded and aggregated.The
slidingWindowSize
must be greater than 0. TheminimumNumberOfCalls
must be greater than 0. If the slidingWindowType is COUNT_BASED, theminimumNumberOfCalls
cannot be greater thanslidingWindowSize
. If the slidingWindowType is TIME_BASED, you can pick whatever you want. Default slidingWindowSize is 100. -
getSlidingWindowType
-
setSlidingWindowType
Configures the type of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed. Sliding window can either be count-based or time-based. IfslidingWindowType
is COUNT_BASED, the lastslidingWindowSize
calls are recorded and aggregated. IfslidingWindowType
is TIME_BASED, the calls of the lastslidingWindowSize
seconds are recorded and aggregated. Default slidingWindowType is COUNT_BASED. -
getMinimumNumberOfCalls
-
setMinimumNumberOfCalls
Configures the minimum number of calls which are required (per sliding window period) before the CircuitBreaker can calculate the error rate. For example, ifminimumNumberOfCalls
is 10, then at least 10 calls must be recorded, before the failure rate can be calculated. If only 9 calls have been recorded the CircuitBreaker will not transition to open even if all 9 calls have failed. Default minimumNumberOfCalls is 100 -
getWritableStackTraceEnabled
-
setWritableStackTraceEnabled
Enables writable stack traces. When set to false, Exception.getStackTrace returns a zero length array. This may be used to reduce log spam when the circuit breaker is open as the cause of the exceptions is already known (the circuit breaker is short-circuiting calls). -
getWaitDurationInOpenState
-
setWaitDurationInOpenState
Configures the wait duration (in seconds) which specifies how long the CircuitBreaker should stay open, before it switches to half open. Default value is 60 seconds. -
getAutomaticTransitionFromOpenToHalfOpenEnabled
-
setAutomaticTransitionFromOpenToHalfOpenEnabled
public void setAutomaticTransitionFromOpenToHalfOpenEnabled(String automaticTransitionFromOpenToHalfOpenEnabled) Enables automatic transition from OPEN to HALF_OPEN state once the waitDurationInOpenState has passed. -
getSlowCallRateThreshold
-
setSlowCallRateThreshold
Configures a threshold in percentage. The CircuitBreaker considers a call as slow when the call duration is greater than slowCallDurationThreshold Duration. When the percentage of slow calls is equal or greater the threshold, the CircuitBreaker transitions to open and starts short-circuiting calls.The threshold must be greater than 0 and not greater than 100. Default value is 100 percentage which means that all recorded calls must be slower than slowCallDurationThreshold.
-
getSlowCallDurationThreshold
-
setSlowCallDurationThreshold
Configures the duration threshold (seconds) above which calls are considered as slow and increase the slow calls percentage. Default value is 60 seconds. -
getBulkheadEnabled
-
setBulkheadEnabled
Whether bulkhead is enabled or not on the circuit breaker. Default is false. -
getBulkheadMaxConcurrentCalls
-
setBulkheadMaxConcurrentCalls
Configures the max amount of concurrent calls the bulkhead will support. -
getBulkheadMaxWaitDuration
-
setBulkheadMaxWaitDuration
Configures a maximum amount of time which the calling thread will wait to enter the bulkhead. If bulkhead has space available, entry is guaranteed and immediate. If bulkhead is full, calling threads will contest for space, if it becomes available. maxWaitDuration can be set to 0.Note: for threads running on an event-loop or equivalent (rx computation pool, etc), setting maxWaitDuration to 0 is highly recommended. Blocking an event-loop thread will most likely have a negative effect on application throughput.
-
getTimeoutEnabled
-
setTimeoutEnabled
Whether timeout is enabled or not on the circuit breaker. Default is false. -
getTimeoutExecutorService
-
setTimeoutExecutorService
References to a custom thread pool to use when timeout is enabled (usesForkJoinPool.commonPool()
by default) -
getTimeoutDuration
-
setTimeoutDuration
Configures the thread execution timeout. Default value is 1 second. -
getTimeoutCancelRunningFuture
-
setTimeoutCancelRunningFuture
Configures whether cancel is called on the running future. Defaults to true.
-