Skip to content

docs(guides): add comprehensive reliability patterns usage guide#468

Merged
kcenon merged 1 commit into
mainfrom
docs/issue-458-create-reliability-patterns-usage-guide
Feb 9, 2026
Merged

docs(guides): add comprehensive reliability patterns usage guide#468
kcenon merged 1 commit into
mainfrom
docs/issue-458-create-reliability-patterns-usage-guide

Conversation

@kcenon

@kcenon kcenon commented Feb 9, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add docs/guides/RELIABILITY_PATTERNS.md covering all 7 reliability components
  • Comprehensive guide with decision flowchart, configuration examples, and composition patterns
  • Includes 4 real-world usage examples and complete API reference appendices

Resolves #458
Part of documentation EPIC kcenon/common_system#325

What's Covered

Component Key Topics
Circuit Breaker State machine (CLOSED/OPEN/HALF_OPEN), common_system adapter, migration notes
Retry Policy 4 strategies (fixed, exponential, linear, fibonacci), conditional retry predicates
Error Boundary 4 degradation levels, 4 policies, 3 fallback strategies (default/cached/alternative)
Graceful Degradation Service priorities, degradation plans, degradable service wrapper
Fault Tolerance Manager CB+retry composition (2 ordering strategies), timeout execution
Resource Manager Token bucket & leaky bucket rate limiting, memory quotas, CPU throttling
Data Consistency Transactions with rollback, state validation, auto-repair, deadlock detection

Test Plan

  • All 7 reliability source files referenced and verified (7/7 PASS)
  • All code examples compile-compatible with actual API signatures
  • Decision guide covers all 7 components with clear selection criteria
  • At least 4 real-world usage examples included (4 provided)
  • Composition patterns explain multi-component integration (3 patterns)
  • Markdown renders correctly on GitHub
  • No broken internal links

Add docs/guides/RELIABILITY_PATTERNS.md covering all 7 reliability
components in the monitoring system:

- Circuit Breaker: state machine, configuration, common_system adapter
- Retry Policy: 4 strategies (fixed, exponential, linear, fibonacci)
- Error Boundary: degradation levels, policies, fallback strategies
- Graceful Degradation: service priorities, degradation plans
- Fault Tolerance Manager: CB+retry composition, timeout execution
- Resource Manager: rate limiting, memory quotas, CPU throttling
- Data Consistency: transactions with rollback, state validation

Includes decision guide, composition patterns, 4 real-world examples,
and complete API reference appendices.

Resolves #458
@kcenon kcenon merged commit 5c29374 into main Feb 9, 2026
21 checks passed
@kcenon kcenon deleted the docs/issue-458-create-reliability-patterns-usage-guide branch February 9, 2026 03:21
kcenon added a commit that referenced this pull request Apr 13, 2026
… (#468)

Add docs/guides/RELIABILITY_PATTERNS.md covering all 7 reliability
components in the monitoring system:

- Circuit Breaker: state machine, configuration, common_system adapter
- Retry Policy: 4 strategies (fixed, exponential, linear, fibonacci)
- Error Boundary: degradation levels, policies, fallback strategies
- Graceful Degradation: service priorities, degradation plans
- Fault Tolerance Manager: CB+retry composition, timeout execution
- Resource Manager: rate limiting, memory quotas, CPU throttling
- Data Consistency: transactions with rollback, state validation

Includes decision guide, composition patterns, 4 real-world examples,
and complete API reference appendices.

Resolves #458
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task] docs: Create reliability patterns usage guide

1 participant