Оглавление справочника
Шесть глав: от общих определений к конкретным источникам шума. Каждая глава самостоятельна и заканчивается итогом, но термины вводятся в первой.
- Что такое шум
Сигнал и шум в инженерном смысле. Ложные срабатывания и пропуски, почему они связаны. Усталость от алертов и как её измерить: доля действий, время реакции, число перезапусков сборок.
- Логи
Уровни логирования и их смысл. Структурированные логи в JSON, обязательные поля, корреляция по идентификатору запроса. Семплинг повторяющихся сообщений, ротация и срок хранения.
- Алерты
Алерты по симптомам против алертов по причинам. Бюджет ошибок и алерты по скорости его расходования. Параметр
for, группировка, подавление, дедупликация и политика эскалации. - Метрики и дашборды
Типы метрик, кардинальность меток и почему идентификатор пользователя не должен быть меткой. Гистограммы и перцентили. Как устроить дашборд, который отвечает на вопрос, а не показывает всё подряд.
- CI и нестабильные тесты
Как отличить нестабильный тест от сломанного. Карантин с владельцем и сроком. Когда повторный запуск допустим и когда он прячет дефект. Скорость конвейера как фактор шума.
- Уведомления и ревью
Автоматическое форматирование и линтеры до ревью, хуки pre-commit. Настройка уведомлений от систем контроля версий и трекеров. Дайджесты вместо потока.
Справочные материалы
- Уровни логирования — таблица с критериями выбора уровня и примерами сообщений.
- Чек-листы — ревизия алертов, ревизия логов, аудит CI.
- Глоссарий — термины, используемые в справочнике.
Справочник обновляется редакциями, а не отдельными публикациями. Текущая редакция 1.3 уточнила главы об алертах, логах и CI и добавила чек-лист аудита конвейера. Главы, не менявшиеся в этой редакции, остаются актуальными: описанные в них принципы не зависят от версий инструментов.