io.lettuce.core.failover.api

Class CircuitBreakerConfig.Builder

java.lang.Object

io.lettuce.core.failover.api.CircuitBreakerConfig.Builder

Enclosing class:

CircuitBreakerConfig

public static class CircuitBreakerConfig.Builder
extends Object

Builder for CircuitBreakerConfig.

Since:

7.4

Method Summary

Modifier and Type	Method and Description
CircuitBreakerConfig.Builder	addTrackedExceptions(Class<? extends Throwable>... exceptionClasses) Add one or more exception classes to track for circuit breaker metrics.
CircuitBreakerConfig	build() Build a new CircuitBreakerConfig instance.
CircuitBreakerConfig.Builder	failureRateThreshold(float failureThreshold) Set the failure rate threshold percentage (0-100).
CircuitBreakerConfig.Builder	metricsWindowSize(int metricsWindowSize) Set the metrics window size in seconds.
CircuitBreakerConfig.Builder	minimumNumberOfFailures(int minimumNumberOfFailures) Set the minimum number of failures required before the circuit breaker can open.
CircuitBreakerConfig.Builder	removeTrackedExceptions(Class<? extends Throwable>... exceptionClasses) Remove one or more exception classes from the tracked exceptions for circuit breaker metrics.
CircuitBreakerConfig.Builder	trackedExceptions(Set<Class<? extends Throwable>> trackedExceptions) Set the exceptions to track for circuit breaker metrics.

Methods inherited from class java.lang.Object

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

Method Detail

failureRateThreshold

public CircuitBreakerConfig.Builder failureRateThreshold(float failureThreshold)

Set the failure rate threshold percentage (0-100). The circuit breaker will open when the failure rate exceeds this threshold.

Parameters:

failureThreshold - the failure rate threshold percentage, must be >= 0

Returns:

this builder

minimumNumberOfFailures

public CircuitBreakerConfig.Builder minimumNumberOfFailures(int minimumNumberOfFailures)

Set the minimum number of failures required before the circuit breaker can open. This prevents the circuit from opening due to a small number of failures.

Parameters:

minimumNumberOfFailures - the minimum number of failures, must be >= 0

Returns:

this builder

trackedExceptions

public CircuitBreakerConfig.Builder trackedExceptions(Set<Class<? extends Throwable>> trackedExceptions)

Set the exceptions to track for circuit breaker metrics. Only these exceptions (and their subclasses) will be counted as failures. This replaces any previously configured tracked exceptions.

Parameters:

trackedExceptions - the set of exception classes to track, must not be null

Returns:

this builder

addTrackedExceptions

@SafeVarargs
public final CircuitBreakerConfig.Builder addTrackedExceptions(Class<? extends Throwable>... exceptionClasses)

Add one or more exception classes to track for circuit breaker metrics. Only these exceptions (and their subclasses) will be counted as failures. This adds to the existing tracked exceptions.

Parameters:

exceptionClasses - one or more exception classes to track, must not be null and must not contain null elements

Returns:

this builder

Since:

7.4

removeTrackedExceptions

@SafeVarargs
public final CircuitBreakerConfig.Builder removeTrackedExceptions(Class<? extends Throwable>... exceptionClasses)

Remove one or more exception classes from the tracked exceptions for circuit breaker metrics.

Parameters:

exceptionClasses - one or more exception classes to remove, must not be null and must not contain null elements

Returns:

this builder

Since:

7.4

metricsWindowSize

public CircuitBreakerConfig.Builder metricsWindowSize(int metricsWindowSize)

Set the metrics window size in seconds. Metrics are collected over this time window.

Parameters:

metricsWindowSize - the metrics window size in seconds, must be >= 2

Returns:

this builder

build

public CircuitBreakerConfig build()

Build a new CircuitBreakerConfig instance.

Returns:

a new CircuitBreakerConfig