Описание алерта как диагностический отчёт

Длинное annotations.description раздувает алерт и не помогает дежурному.

Антипаттерн

Превращать annotations.description в подробный отчёт: многострочный блок |- со всеми лейблами, их значениями и развёрнутым контекстом.

Когда алертов десятки, в такое описание никто не заглядывает. Дежурный читает заголовок и идёт за деталями в систему мониторинга.

Как надо

  • В annotations.summary одной строкой напишите, что сработало. Именно она станет заголовком алерта в списке, карточке и уведомлениях.
  • В annotations.description оставьте короткое пояснение.
  • Ссылку на ранбук положите в annotations.runbook_url, а на дашборд в annotations.dashboard_url: полный http(s)-адрес превратится в ссылку в карточке алерта, письме и чате.

Дежурный получает суть и указатели, куда смотреть дальше. Этого достаточно, чтобы начать разбор.

На этой странице