Documentation

Getting started

Install Burnless and run your first SLO in under 5 minutes.

Prerequisites

  • Go 1.24 or later
  • A running Prometheus instance (optional for local testing)
  • kubectl (optional, for Kubernetes features)

Install

# macOS brew install burnless # or build from source git clone https://github.com/Custos-com/Burnless.git cd burnless make build

Create your first sre.yaml

burnless init ? Service name: payments-api ? Team: platform-engineering ? SLO target: 99.9% ✓ Created sre.yaml

Validate your config

burnless validate ✓ sre.yaml is valid

Start the agent

burnless agent → Watching SLOs for payments-api... → Polling Prometheus every 60s

You're all set!

The agent is now watching your SLOs. If burn rate exceeds 14.4× it will run your runbook automatically and notify Slack before paging anyone.