Document burn rate helper

This commit is contained in:
Oliver Neumann 2025-08-11 10:00:00 +00:00
parent d3b59c2bce
commit ac064ec4fe

View file

@ -21,3 +21,8 @@ Built for my own use. Tested on the Nexus prod setup.
pip install prometheus-api-client pyyaml rich
## Burn rate
The `burn_rate()` helper calculates how quickly you're spending your error budget
relative to a 30-day window. A burn rate > 1 means you'll exhaust the budget before the window closes.