iron_reliability 0.3.0

Resilience patterns for distributed systems
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

# iron_cage_reliability

Circuit breakers and fault tolerance for multi-agent systems.

[![Documentation](https://img.shields.io/badge/docs.rs-iron_reliability-E5E7EB.svg)](https://docs.rs/iron_reliability)

## Installation

```toml
[dependencies]
iron_cage_reliability = { version = "0.1", features = ["full"] }
```


## Features

- `enabled` (default): Full circuit breaker functionality
- `full`: All functionality (currently same as `enabled`)


## Quick Start

```rust
use iron_cage_reliability::CircuitBreaker;

// Create circuit breaker with 5-failure threshold
let cb = CircuitBreaker::new(5, 60);

// Perform operation with circuit breaker protection
match cb.call("external_api", || {
    call_external_service()
}) {
    Ok(result) => println!("Success: {:?}", result),
    Err(e) if cb.is_open("external_api") => {
        println!("Circuit breaker open, using fallback");
    },
    Err(e) => println!("Call failed: {}", e),
}
```


## Documentation

- [API Reference](https://docs.rs/iron_cage_reliability)
- [Reliability Patterns](docs/patterns.md)


<details>
<summary>Scope & Boundaries</summary>

**Responsibilities:**
Implements circuit breaker pattern (Closed/Open/HalfOpen states) for agent reliability with automatic failure detection and recovery. Prevents cascading failures by temporarily disabling failing agents while allowing periodic retry attempts. Requires Rust 1.75+, all platforms supported, uses exponential backoff for recovery.

**In Scope:**
- Circuit breaker pattern implementation
- Automatic fallback mechanisms
- Retry logic with exponential backoff
- Service health monitoring
- Failure threshold tracking

**Out of Scope:**
- Cost tracking (see iron_cage_cost)
- PII detection (see iron_cage_safety)
- Agent orchestration (see iron_cage_cli)
- Configuration management (see iron_cage_types)

</details>


<details>
<summary>Directory Structure</summary>

### Source Files

| File | Responsibility |
|------|----------------|
| lib.rs | Circuit breaker pattern for preventing cascading failures. |

**Notes:**
- Entries marked 'TBD' require manual documentation
- Entries marked '⚠️ ANTI-PATTERN' should be renamed to specific responsibilities

</details>


## License

MIT