srekit runbook¶
Сгенерировать runbook — operational playbook, к которому дежурный обращается, когда сработал алерт. Секции: Symptoms, Severity & SLO impact, Diagnose, Mitigate, Verify, After the fact, References.
Синопсис¶
Флаги¶
| Флаг | Обязательный | Описание |
|---|---|---|
--title |
да | Тема runbook (часто — имя алерта) |
--service |
нет | Сервис, к которому относится runbook |
--alert |
нет | Имя / id конкретного алерта |
Плюс общие output-флаги. Default имя файла: runbook-<slug-of-title>.md.
Примеры¶
srekit runbook --title "p99 latency spike" --service api-gw --alert APIGwHighP99 \
--out runbook-apigw-p99.md
В stdout без service:
Структура секций¶
- Front matter:
id,creation_date,modification_date,type: runbook,title,service,alert,tags - Симптомы (Symptoms) — как алерт выглядит на практике
- Тяжесть и влияние на SLO (Severity & SLO impact) — насколько всё плохо и по какому бюджету бьёт
- Диагностика (Diagnose) — что проверить, какие дашборды смотреть
- Смягчение (Mitigate) — ограниченные шаги для остановки user impact: немедленное действие, откат, переключение
- Проверка (Verify) — как убедиться что митигация сработала
- Постфактум (After the fact) — завести постмортем выше заданного SEV, вернуть сюрпризы обратно в этот runbook
- Ссылки (References)
Структура данных для шаблона¶
runbook шипится как v1 YAML-артефакт (internal/tmpl/templates/runbook.yaml) — frontmatter, H1, meta_bullets, секции (symptoms, severity_slo_impact, diagnose, mitigate, verify, after_the_fact, references). Template-выражения обращаются к .Meta.<Field> для ID, Title, Service, Alert, Now. См. srekit postmortem для полной схемы.
См. также¶
srekit postmortem— ретроспектива, которая пишется после инцидента, под который этот runbook.