Structured Logs

Кодирование structured-logs
Описание

Структурированные логи — это логи, которые можно обработать в автоматическом режиме и выделить из логов ключевые значения. Логи могут поставляться в JSON или любом другом удобном для автоматической обработки формате.

Ценность
Преимущества:
  • Структурированные логи проще обрабатывать и анализировать с помощью автоматических систем. Тем самым можно повысить прозрачность системы, ускорить отладку и поиск причин инцидентов.
  • Команда получит удобный инструмент для отладки приложения. Создав структуру логов, разработчик сможет определить в каком модуле, на каком сервере, по какому запросу и какое событие произошло, увидит, как часто происходят те или иные события. Будет возможно фильтровать события.
  • Администраторам и инженерам технической поддержки будет проще диагностировать причины инцидентов. Будет проще настраивать алерты на события.
  • PO получат возможность строить аналитические отчеты на основе логируемых в приложении событий.
Последствия отсутствия:
  • Отсутствие структуры в логах может негативно повлиять на время восстановления приложения при наступлении инцидента.
Действия для развития:
  • Пример от DataDog для Go.
Критерии оценки 8
SURVEY

Формат логов описан в виде кода или в документации

Варианты по умолчанию: Да / Нет / Частично
SURVEY

Определены ключевые параметры, которые команда хочет получать о событии из логов

Варианты по умолчанию: Да / Нет / Частично
SURVEY

Правила для обработки логов легко поддерживать

Варианты по умолчанию: Да / Нет / Частично
SURVEY

Логи содержат структурированные параметры, пригодные для автоматического анализа

Варианты по умолчанию: Да / Нет / Частично
CHECK

Формат логов описан в виде кода или в документации

CHECK

Определены ключевые параметры, которые команда хочет получать о событии из логов

CHECK

Правила для обработки логов легко поддерживать

CHECK -1

Параметры в логах не выделены или не сгруппированы, обработать их в автоматическом режиме сложно или невозможно

Ресурсы 1
  • Источник
Метаданные
ID:
7a71bbd1-8a28-4643-a3e9-d64445ceaf14
Slug:
structured-logs
Версия:
2.0
Проекты:
Client2/Project1 Client1/Project1
Критерии:
4 survey 4 check
Создано:
2026-04-30
Обновлено:
2026-04-30