Skip to main content

RedisCircuitBreaker

Struct RedisCircuitBreaker 

Source
pub struct RedisCircuitBreaker { /* private fields */ }
Expand description

Per-backend circuit breaker, persisted in Redis.

Same Closed → Open → HalfOpen state machine as CircuitBreaker, and the same method names, but every operation is a synchronous Redis round trip (via the shared [crate::redis_protocol] RESP client) instead of an in-memory HashMap update — so state survives a process restart, and is shared across every rws instance pointed at the same Redis server.

§Why Redis, not the model layer

The model layer (DbPool, sqlx) is async fn-only, while CircuitBreaker’s methods and Middleware::handle (what RetryLayer implements) are both synchronous — the identical async/sync mismatch that left SqliteRateLimiter unbuilt after crate::rate_limit::RedisRateLimiter shipped. Redis, reached over a plain blocking TcpStream, stays fully synchronous and drops into the same call sites CircuitBreaker already has, with no new Cargo dependency.

§Consistency

Each operation is a read-then-write (GET then SET) against one Redis key per backend — not a single atomic command. Two rws instances racing to record a failure for the same backend at the same instant can lose one of the two increments. This is a deliberate simplification: unlike a rate limit (a hard resource/security boundary, where RedisRateLimiter uses genuinely atomic INCR for exactly this reason), a circuit breaker is a self-healing heuristic where opening one failure late — or one request later than a perfectly-synchronized count would — has no real consequence.

§Example

use rust_web_server::circuit_breaker::RedisCircuitBreaker;

let breaker = RedisCircuitBreaker::new("127.0.0.1:6379", None, 5, 30);

match breaker.is_available("backend-a:8080") {
    Ok(true) => { /* forward the request */ }
    Ok(false) => { /* short-circuit — return 503 without contacting the backend */ }
    Err(e) => { /* Redis unreachable — decide fail-open vs fail-closed yourself */ }
}

Implementations§

Source§

impl RedisCircuitBreaker

Source

pub fn new( addr: impl Into<String>, password: Option<String>, failure_threshold: u32, recovery_secs: u64, ) -> Self

Create a breaker that connects to addr (e.g. "127.0.0.1:6379"). password is passed to Redis AUTH if Some.

Source

pub fn from_env() -> Self

Build a breaker from environment variables:

  • RWS_REDIS_HOST (default 127.0.0.1)
  • RWS_REDIS_PORT (default 6379)
  • RWS_REDIS_PASSWORD (optional)
  • RWS_CONFIG_CIRCUIT_BREAKER_FAILURE_THRESHOLD (default 5)
  • RWS_CONFIG_CIRCUIT_BREAKER_RECOVERY_SECS (default 30)
Source

pub fn set_limits(&self, failure_threshold: u32, recovery_secs: u64)

Update the thresholds on a live breaker without restarting.

Source

pub fn is_available(&self, backend: &str) -> Result<bool>

Returns Ok(true) if a request should be forwarded to backend.

Transitions Open → HalfOpen when the recovery window has elapsed. Returns Err if Redis is unreachable — callers decide whether that means fail open (treat as available) or fail closed (treat as not).

Source

pub fn record_success(&self, backend: &str) -> Result<()>

Record a successful response for backend.

Transitions HalfOpen → Closed and resets the failure counter.

Source

pub fn record_failure(&self, backend: &str) -> Result<()>

Record a failed response for backend.

In Closed state, increments the counter and opens the circuit when failure_threshold is reached. In HalfOpen state, immediately re-opens the circuit and resets the recovery timer.

Source

pub fn reset(&self, backend: &str) -> Result<()>

Reset backend to Closed with zero failures.

Source

pub fn state(&self, backend: &str) -> Result<BreakerState>

Return the current state for backend (defaults to Closed if unseen).

Trait Implementations§

Source§

impl Clone for RedisCircuitBreaker

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more