Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,43 @@ runbooks/ one anchor per alert, linked from each rule's runbook_url
scripts/ policy checks on rendered dashboards
```

## Architecture

```mermaid
flowchart LR
subgraph git["Git: source of truth"]
rules["prometheus/rules"]
tests["prometheus/tests"]
dash["grafana/dashboards<br/>+ lib/common.libsonnet"]
rb["runbooks"]
end

subgraph ci["CI: make ci"]
fmt["jsonnetfmt --test"]
chk["promtool check rules"]
ut["promtool test rules<br/>firing + non-firing cases"]
build["jsonnet build<br/>build/dashboards/*.json"]
pol["check_dashboards.py<br/>uid, datasource, editable"]
end

tf["deploy/terraform<br/>grafana_folder + grafana_dashboard"]
graf["Grafana / Grafana Cloud"]
prom["Prometheus rule_files<br/>or mimirtool rules sync"]
route["Alert routing<br/>warning: ticket, critical: page"]

rules --> chk
rules --> ut
tests --> ut
dash --> fmt
dash --> build
build --> pol
pol --> tf
tf --> graf
ut --> prom
prom --> route
route -. "runbook_url" .-> rb
```

## What's in it

| Area | Highlights |
Expand Down
Loading