Логирование
Логи это данные которые хранят в себе информацию о разных событиях присходящих внутри программы и при при взамодействии с ней. Информация в логах является историей работы прогрммы, по ней можно воссоздать всю хронология событий. К примеру при логировании базы данных, имея список логов можно воссоздать и саму базу, если вдруг она была уничтожена. Можно узнать скорость работы, по логам из разных взамодействующих между собой программно-аппартаных комплексах, можно выстроить последовательность действий или маршрут. Логи это по большому счёту мусор, но мосурор в котором хранится много всего интересного и полезного.
Требования
- Легкость и точность в понимании произошедшего события
- Доступ к логам в режиме реального времени
- Права доступа в логам
- Компактность записи
- Высокая скорость записи логов
- Запись логов в любом окружении
- Схема описания логов
- Совместимость с syslog
Сборщики логов и системы доставки не будут рассматриваться сознательно
Данные для логирования
- Время
- Название программы
- Название части программы, если существует
- Событие
- Тип сообщения (события)
- Краткое описание
- Подробное описание
- Данные доступа
Тип сообщений (событий)
Название | Определения | Описание |
---|---|---|
debug | Отладка | Этот тип сообщений содержит записи о крупных изменениях состояний, таких как обращение к базам данных, запуск или остановка сервиса, а также подтверждение успешной обработки информации. |
trace | Трассировка | Этот тип записи сохраняет все этапы исполненных процессов. Если возникают проблемы с определением источника проблемы, это именно то место, где следует начать поиски. |
info | Информация | Это основной файл, который предоставляет информацию о функционировании сервиса или службы |
warn | Предупреждение | -- |
alarm | Критическое действие | -- |
tag | Cобытие определяемое разработчиком | -- |
error | Сохраняет типичные ошибки |
Отладочные данные событий
Данные об ошибках
Хранение логов
- Сжатие сообщений
- Построчное хранение
- Последовательность действий
Тип хранилища: В БД В Файлах
Просмотр логов
Основы и принципы удобного анализа
Для создания удобных для работы файлов логирования, необходимо учесть ряд важных аспектов:
-
"Логирование важных событий": Это включает в себя все ключевые моменты, такие как запуск приложения, остановка или возобновление транзакций, успешная регистрация, ошибки и прочее.
-
"Оптимизация логов": Исключение часто повторяющихся слов помогает упростить будущий поиск информации в логах.
-
"Теги в логировании": Добавление тегов к записям лога позволяет быстро находить данные, даже если они расположены в разных категориях.
-
"Стандартизированный формат логирования": Установка единого формата для файлов логирования облегчает работу как для разработчиков, так и для пользователей.
-
"Читаемость логов": Каждое новое сообщение следует начинать с новой строки, чтобы улучшить читаемость.
-
"Использование релевантной информации": Используйте только ту информацию, которая действительно нужна, чтобы избегать ненужной перегрузки данных.
-
"Сознательное использование типов и уровней логирования": Правильная структурировка данных возможна только при осознанном использовании типов и уровней логирования.