redis.clients.jedis

Class MultiDbConfig.CircuitBreakerConfig

java.lang.Object

redis.clients.jedis.MultiDbConfig.CircuitBreakerConfig

Enclosing class:

MultiDbConfig

public static final class MultiDbConfig.CircuitBreakerConfig
extends java.lang.Object

Configuration for circuit breaker failure detection.

This class encapsulates all circuit breaker-related settings including failure rate threshold, sliding window size, minimum failures, and exception handling.

Since:

7.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiDbConfig.CircuitBreakerConfig.Builder Builder for MultiDbConfig.CircuitBreakerConfig.

Method Summary

Modifier and Type	Method and Description
static MultiDbConfig.CircuitBreakerConfig.Builder	builder() Creates a new Builder instance for configuring CircuitBreakerConfig.
float	getFailureRateThreshold() Returns the failure rate threshold percentage for circuit breaker activation.
java.util.List<java.lang.Class>	getIgnoreExceptionList() Returns the list of exception classes that are ignored by the circuit breaker and neither count as failures nor successes.
java.util.List<java.lang.Class>	getIncludedExceptionList() Returns the list of exception classes that are recorded as circuit breaker failures and increase the failure rate.
int	getMinNumOfFailures() Returns the minimum number of failures before circuit breaker is tripped.
int	getSlidingWindowSize() Returns the size of the sliding window used to record call outcomes when the circuit breaker is CLOSED.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFailureRateThreshold

public float getFailureRateThreshold()

Returns the failure rate threshold percentage for circuit breaker activation.

0.0f means failure rate is ignored, and only minimum number of failures is considered.

When the failure rate exceeds both this threshold and the minimum number of failures, the circuit breaker transitions to the OPEN state and starts short-circuiting calls, immediately failing them without attempting to reach the Redis database. This prevents cascading failures and allows the system to fail over to the next available database.

Range: 0.0 to 100.0 (percentage)

Returns:

failure rate threshold as a percentage (0.0 to 100.0)

See Also:

getMinNumOfFailures()

getSlidingWindowSize

public int getSlidingWindowSize()

Returns the size of the sliding window used to record call outcomes when the circuit breaker is CLOSED.

Default:

Returns:

sliding window size (calls or seconds depending on window type)

getMinNumOfFailures

public int getMinNumOfFailures()

Returns the minimum number of failures before circuit breaker is tripped.

0 means minimum number of failures is ignored, and only failure rate is considered.

When the number of failures exceeds both this threshold and the failure rate threshold, the circuit breaker will trip and prevent further requests from being sent to the database until it has recovered.

Returns:

minimum number of failures before circuit breaker is tripped

See Also:

getFailureRateThreshold()

getIncludedExceptionList

public java.util.List<java.lang.Class> getIncludedExceptionList()

Returns the list of exception classes that are recorded as circuit breaker failures and increase the failure rate.

Any exception that matches or inherits from the classes in this list counts as a failure for circuit breaker calculations, unless explicitly ignored via getIgnoreExceptionList(). If you specify this list, all other exceptions count as successes unless they are explicitly ignored.

Default: JedisConnectionException

Returns:

list of exception classes that count as failures, never null

See Also:

getIgnoreExceptionList()

getIgnoreExceptionList

public java.util.List<java.lang.Class> getIgnoreExceptionList()

Returns the list of exception classes that are ignored by the circuit breaker and neither count as failures nor successes.

Any exception that matches or inherits from the classes in this list will not affect circuit breaker failure rate calculations, even if the exception is included in getIncludedExceptionList().

Default: null (no exceptions ignored)

Returns:

list of exception classes to ignore for circuit breaker calculations, may be null

See Also:

getIncludedExceptionList()

builder

public static MultiDbConfig.CircuitBreakerConfig.Builder builder()

Creates a new Builder instance for configuring CircuitBreakerConfig.

Returns:

new Builder instance with default values