devnoize справочник

О проекте

devnoize — справочник о том, как отличать сигнал от шума в инженерных системах и как уменьшать шум, не теряя сигнала.

Зачем этот справочник

О мониторинге, логировании и CI написано много, но почти всегда с точки зрения того, как добавить: ещё одну метрику, ещё один алерт, ещё одну проверку. Гораздо реже обсуждается обратная сторона — что происходит, когда всего этого становится слишком много. Системы, которые сообщают обо всём, на практике сообщают ни о чём: люди перестают читать уведомления, перезапускают сборки не глядя и узнают об инцидентах от пользователей.

Справочник собирает практики, которые помогают держать количество сообщений под контролем. Он не описывает конкретный продукт и не заменяет документацию к инструментам. Его задача — дать общий язык и набор принципов, которые можно применить в любом окружении.

Кому он полезен

  • Разработчикам, которые пишут код, работающий в рабочем окружении, и хотят, чтобы его логи и метрики помогали при разборе проблем.
  • Дежурным инженерам и SRE, которые отвечают на вызовы и хотят, чтобы каждый вызов был оправдан.
  • Руководителям команд, которым нужно измерить нагрузку на дежурных и обосновать время на наведение порядка.

Принципы

  • Практичность. Каждая рекомендация должна быть применима завтра. Где это возможно, приводится пример кода или конфигурации.
  • Без привязки к вендорам. Примеры используют распространённые открытые инструменты, но каждый совет сформулирован через принцип, который можно перенести в другую систему.
  • Измеримость. Шум — не вопрос вкуса. Для каждой области предлагается способ его посчитать.
  • Краткость. Справочник не пытается охватить всё. Если тема подробно описана в стандарте или официальной документации, даётся ссылка.

Редакции

Справочник выпускается редакциями. Текущая — 1.3. Главы, которые не менялись в последней редакции, остаются актуальными: описанные в них принципы не зависят от версий инструментов. Номер редакции и месяц её выпуска указаны внизу каждой страницы.

Лицензия

Материалы справочника распространяются по лицензии Creative Commons «Атрибуция» 4.0 Международная (CC BY 4.0). Их можно копировать, распространять и адаптировать для любых целей, в том числе коммерческих, при условии указания источника. Примеры кода можно использовать без ограничений.