Resilient Circuit

Getting Started

  • Installation
    • Basic Installation
    • PostgreSQL Support
    • Development Installation
  • Quick Start
    • Basic Usage
    • Advanced Usage
    • Retry Pattern
    • Combining Patterns

User Guide

  • Advanced Usage
    • PostgreSQL Shared Storage
      • Configuration
    • Custom Exception Handling
    • Monitoring and Status Changes
    • Accessing Circuit Breaker State
    • Performance Considerations
  • PostgreSQL Storage for Distributed Systems
    • Overview
    • Why PostgreSQL Storage?
    • Installation
    • Database Setup
      • 1. Create PostgreSQL Database
      • 2. Configure Environment Variables
      • Environment Variables
      • 3. Initialize Database Tables
      • CLI Options
    • Database Schema
      • Table Structure
      • Indexes
    • Usage
      • Basic Usage with PostgreSQL
      • Distributed System Example
      • Explicit Storage Configuration
    • Monitoring
      • Query Circuit Breaker State
    • Fallback Behavior
      • Automatic Fallback to In-Memory
    • Performance Considerations
      • Connection Pooling
      • Latency
    • Best Practices
    • Troubleshooting
      • Connection Errors
      • State Not Syncing
      • Table Not Found
    • See Also
  • Distributed Systems
    • Overview
    • Why Distributed Circuit Breakers?
    • Architecture Patterns
      • Single Service, Multiple Instances
      • Multiple Services, Shared Resource
      • Per-Instance vs Shared Keys
    • Use Cases
      • Microservices Architecture
      • Kubernetes Deployments
      • Serverless Functions
      • Multi-Region Deployments
    • State Synchronization
      • How It Works
      • State Transition Example
      • Concurrency Handling
    • Performance Optimization
      • Circuit Breaker Caching
      • Lazy Loading
      • Connection Pooling
    • Monitoring and Observability
      • Real-Time Monitoring
      • Alerting
      • Metrics Collection
    • Best Practices
    • Troubleshooting
      • Instances Not Syncing
      • High Database Load
      • State Not Persisting
    • See Also
  • Command Line Interface
    • Installation
    • PostgreSQL Setup
      • Basic Usage
      • Options
      • Environment Variables
      • Example Configuration

Reference

  • API Reference
    • CircuitProtectorPolicy
      • CircuitProtectorPolicy
        • CircuitProtectorPolicy.DEFAULT_THRESHOLD
        • CircuitProtectorPolicy.__init__()
        • CircuitProtectorPolicy.execution_log
        • CircuitProtectorPolicy.status
        • CircuitProtectorPolicy.on_status_change()
    • CircuitStatus
    • RetryWithBackoffPolicy
      • RetryWithBackoffPolicy
        • RetryWithBackoffPolicy.__init__()
    • SafetyNet
      • SafetyNet
        • SafetyNet.__init__()
        • SafetyNet.__call__()
    • ExponentialDelay
      • ExponentialDelay
        • ExponentialDelay.min_delay
        • ExponentialDelay.max_delay
        • ExponentialDelay.factor
        • ExponentialDelay.jitter
        • ExponentialDelay.for_attempt()
        • ExponentialDelay.__init__()
    • FixedDelay
      • FixedDelay
        • FixedDelay.__init__()
    • Storage Classes
      • CircuitBreakerStorage
        • CircuitBreakerStorage.get_state()
        • CircuitBreakerStorage.set_state()
      • InMemoryStorage
        • InMemoryStorage.__init__()
        • InMemoryStorage.get_state()
        • InMemoryStorage.set_state()
      • PostgresStorage
        • PostgresStorage.__init__()
        • PostgresStorage.get_state()
        • PostgresStorage.set_state()
  • Changelog
    • Version 0.3.0 (2025-11-14)
      • Added
      • Changed
    • Version 0.2.0 (2025-11-10)
      • Added
    • Version 0.1.0 (2023-06-15)
      • Added
Resilient Circuit
  • Search

© Copyright 2025, Resilient Circuit Contributors.

Built with Sphinx using a theme provided by Read the Docs.