Описание алерта как диагностический отчёт
Длинные многострочные annotations.description раздувают payload и не помогают дежурному.
Антипаттерн
Использовать annotations.description как контейнер для подробной диагностики — многострочный YAML literal-block |- с перечислением всех labels, их значений и развёрнутого контекста. На десятках или сотнях алертов в такой description дежурный всё равно не заглядывает — он смотрит заголовок и идёт в систему мониторинга.
Алерт — это уведомление: «что-то случилось, иди разберись». Полная диагностика живёт в системе мониторинга, логах и трейсах. Длинный description не помогает дежурному быстрее принять решение — он всё равно прочитает заголовок и пойдёт за деталями в соответствующие системы.
Как надо
- В
annotations.summary— одна строка, что именно сработало - В
annotations.description— короткое пояснение и ссылка на ранбук (https://runbooks.example.com/kafka/under-replicated) или дашборд Grafana - Никаких многострочных
descriptionчерез|-на десятки строк
Дежурный получает уведомление и указатели на источник информации. Этого достаточно для начала диагностики