Skip to main content

Documentation

The full documentation lives in docs/:

PageWhat it covers
Getting StartedInstallation, the inline form, the Outcome, a first class-form point, the trace middleware.
Control PointsNaming, domains, the builder, the class form, nesting, Laravel Context.
Risks and Correctionsrecover() semantics, the catch-all, escalate(), the risks Monitor raises.
Policies and LimitsRetry, Transaction, Breaker, pipeline order, the three limits, profiles.
RecordsThe record schema, levels, redaction, NDJSON, Monitor::log(), events.
TracingTrace ids, the middleware, Http::traced(), jobs, console.
JobsDispatching a point as a job, Horizon tags, WaitForBreaker, what a job inherits.
BreakersThe state machine, the standalone API, the route middleware.
StoreEnabling the outcome store, what is written and when, monitor:outcomes, pruning.
Inventorymonitor:points, every rule, --check in CI, monitor:explain, make:control-point.
TestingMonitor::fake() and its assertions, the Pest expectations, the PHPStan rule, and the package's own tests.
AgentsThe Boost guideline and skill, the MCP server, its tools, resources and prompt.
ConfigurationEvery key in config/monitor.php with its type, default and environment variable.
ExtendingCustom policies, escalations, inventory rules, event listeners.
UpgradingEvery 0.1 surface and its 1.0 replacement.