faultcore provides fault injection and network behavior simulation for Python applications.

This site is organized to teach usage first, with direct entries for every public decorator and policy/context API.

• Read the Docs URL: https://faultcore.readthedocs.io/en/latest/

• PyPI package: https://pypi.org/project/faultcore/

Get started

• Getting Started
  • 1) Prerequisites
  • 2) Install and build
  • 3) Validate runtime health
  • 4) Run your process with interceptor enabled
  • 5) Apply your first decorator
  • 6) Move to reusable policies
  • 7) Generate a run report
  • Next steps
• Concepts
  • Mental model
  • When to use decorators directly
  • When to use policies
  • Fault family guide
  • Typical rollout strategy

API

• API Reference
  • timeout
  • rate
  • latency
  • jitter
  • packet_loss
  • burst_loss
  • dns
  • session_budget
  • uplink
  • downlink
  • correlated_loss
  • connection_error
  • half_open
  • packet_duplicate
  • packet_reorder
  • payload_mutation
  • fault
  • policy_context
  • Policy Registry
  • Policy Application

Guides

• CLI Usage
  • Command overview
  • Quick start
  • faultcore doctor
  • faultcore run
  • faultcore report
  • CI-friendly flow
  • Related
• Examples
  • Testing scenario map
  • Pattern: deterministic baseline first
  • Pattern: one fault family per test
  • Pattern: reusable policy profiles
  • Pattern: explicit assertions
  • Example: HTTP client test
  • Example: TCP protocol client test
  • Example: UDP protocol client test
• Troubleshooting
  • Build issues
  • Runtime issues in fault injection
  • Symptom-based troubleshooting
  • Documentation quality gate before merge
  • Documentation quality checklist

Deep dives

• Architecture
• Policies and Context
• Interceptor and SHM
• Faultcore Shared Memory Protocol
• Operations and Tuning Guide
• Testing and Examples