CacheFlow.CircuitBreaker

A resilient circuit breaker implementation for CacheFlow that prevents cascading failures and provides intelligent failure handling with configurable thresholds and recovery mechanisms.

Features

• 🛡️ Thread-safe Circuit Breaker: Robust implementation for concurrent environments
• ⚡ High Performance: Minimal overhead during normal operation
• 🎯 Configurable Thresholds: Customize failure limits and recovery times
• 📊 Sliding Window: Efficient failure tracking with automatic cleanup
• 🔄 Automatic Recovery: Self-healing with half-open state testing
• 📝 Comprehensive Logging: Detailed failure and state transition tracking
• 🎨 Decorator Pattern: Clean integration with existing CacheFlow implementations
• 🚦 State Management: Closed, Open, and Half-Open states
• ⚠️ Exception Handling: Clear error reporting with CircuitBreakerOpenException

Installation

dotnet add package CacheFlow.CircuitBreaker

Quick Start

// Add circuit breaker to your services
services.AddCacheFlow()
        .AddCircuitBreaker(options =>
        {
            options.FailureThreshold = 5;
            options.MinimumThroughput = 3;
            options.DurationOfBreak = TimeSpan.FromSeconds(30);
            options.SamplingDuration = TimeSpan.FromSeconds(60);
        });

// Use in your code
public class UserService
{
    private readonly ICacheFlowManager _cache;

    public UserService(ICacheFlowManager cache)
    {
        _cache = cache;
    }

    public async Task<UserProfile> GetUserProfileAsync(string userId)
    {
        try
        {
            return await _cache.GetOrCreateAsync(
                $"user:{userId}",
                userId,
                async (id, ct) => await FetchUserProfileFromDatabase(id)
            );
        }
        catch (CircuitBreakerOpenException)
        {
            // Handle circuit breaker open state
            return await FetchUserProfileFromDatabase(userId);
        }
    }
}