nat.middleware.circuit_breaker.circuit_breaker_middleware_config#

Configuration for circuit breaker middleware.

Classes#

CircuitBreakerMiddlewareConfig

Configuration for circuit breaker middleware.

Module Contents#

class CircuitBreakerMiddlewareConfig#

Bases: nat.middleware.dynamic.dynamic_middleware_config.DynamicMiddlewareConfig

Configuration for circuit breaker middleware.

Attributes:

failure_threshold: Number of consecutive failures required to trip the circuit breaker. cooldown_period: Time in seconds to wait in OPEN state before probing. half_open_success_threshold: Consecutive successful probes required to recover to CLOSED. probe_timeout: Optional timeout in seconds for probe calls in HALF_OPEN state. circuit_breaker_message: Optional custom message returned when short-circuited.

failure_threshold: int = None#
cooldown_period: float = None#
half_open_success_threshold: int = None#
probe_timeout: float | None = None#
circuit_breaker_message: str | None = None#