Ведение журналов событий (логирование)

Реализована Администрирование и Разработка

Программный код не всегда работает так как нужно. Поэтому для диагностики проблем существует возможность записи всех важных (и не очень) системных событий в журналы событий. Файл журнала — это текстовый файл, в который записываются события. Журналы показывают, что происходило за кулисами и когда это произошло. Так что если что-то пойдет не так, в наличии будет подробный отчет обо всех действиях, предшествовавших событию.

Содержимое

    Структура журналов событий

    События для разделены на несколько отдельных каналов по их назначению:

    1. Основные события.
    2. События получателя запросов.
    3. События в инструментах.
    4. События в схемах.
    5. События в конфигурациях.

    Некоторые каналы событий имеют собственное расположение, все остальные размещаются в основных журналах.

    Основные события

    В данном канале размещены все основные события которые невозможно отнести к другим более узконаправленным каналам. Например события загрузки плагина, загрузки схем и инструментов.

    Расположение

    В файловой системе журналы основных событий располагаются в директории путь_до_wordpress/wp-content/uploads/wc1c/logs.

    Настройка уровня

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

    События получателя запросов

    У плагина существует механизм приема фоновых запросов. Данный механизм используется в схемах.

    Расположение

    Файлы располагаются там же, где и файлы основных событий, только в наименовании файлов вместо main используется receiver.

    Настройка уровня

    Уровень настраивается там же, где и уровень для основных событий — в основных настройках плагина.

    События в инструментах

    Все события произошедшие непосредственно при работе с инструментами записываются в отдельный каталог.

    Расположение

    Файлы журналов событий в инструментах располагаются в путь_до_wordpress/wp-content/uploads/wc1c/tools/logs.

    Настройка уровня

    Уровень настраивается там же, где и уровень для основных событий — в основных настройках плагина.

    События в схемах

    Все события произошедшие непосредственно во время работы схем записываются в отдельный файловый каталог.

    События произошедшие в алгоритмах схем в большинстве случаев относятся к событиям конфигураций. К событиям схем относятся узконаправленные события технического характера.

    Расположение

    Файлы журналов событий в схемах располагаются в путь_до_wordpress/wp-content/uploads/wc1c/schemas/logs.

    Настройка уровня

    Уровень настраивается там же, где и уровень для основных событий — в основных настройках плагина.

    События в конфигурациях

    Все события которые относятся конкретно к событиям конфигураций, но не относятся к событиям схем записываются в отдельное пространство.

    Расположение

    Файлы журналов для конфигураций располагаются в подпапке /logs в основной директории для загрузки файлов у конкретной конфигурации.

    Например путь_до_wordpress/wp-content/uploads/wc1c/configurations/{schema_id-configuration_id}/logs

    Настройка уровня

    Уровень логирования настраивается непосредственно в настройках конкретной конфигурации. Сделано это для удобства отладки на уровне конфигураций. Все остальное практически идентично логированию основного плагина.

    При этом в основных настройках плагина возможно запретить изменение настроек уровня логирования на уровне конфигураций и применять глобальные настройки.

    Уровни записи событий

    Полная запись всех событий в программном коде осуществляется согласно уровням событий. Чем ниже уровень, тем больше будет записано данных.

    Необходимо использовать подходящий под задачи уровень событий.

    Отладка — DEBUG (100)

    Данный уровень записывает огромное количество отладочных данных в файл журнала. Используется только при отладке неизвестных проблем. Если ставить на рабочем сайте данный уровень, файлы логов будут иметь очень большой физический размер.

    На работающем сайте необходимо всегда отключать данный уровень.

    Информация — INFO (200)

    Добавляются информационные события по типу уровня отладки, но только без огромных отладочных данных. Показывается весь процесс вызовов и отработки алгоритмов.

    На работающем сайте необходимо всегда отключать данный уровень.

    Замечание — NOTICE (250)

    Информация о нормальных, но важных событиях.

    На работающем сайте рекомендуется отключать данный уровень. Рекомендацией можно пренебречь, если у вас имеются лишние дисковые ресурсы которые некуда девать.

    Предупреждение — WARNING (300)

    Информация о возможных проблемах.

    Основной рабочий уровень ведения журналов событий. Используется по умолчанию.

    Ошибка — ERROR (400)

    Информация об возникших ошибках. При данной уровне происходит запись всех ошибок, включая критические и те без которых работа полностью невозможна.

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

    Критическая ошибка — CRITICAL (500)

    Информация о критическом состоянии. При установке данного уровня происходит запись критических ошибок. Необходимо позаботится о их решении, но работа с ними возможна.

    Записываются всегда, отключить запись событий данного уровня в ручную невозможно.

    Тревога — ALERT (550)

    На данном уровне требуется немедленное вмешательство. В противном случае велика вероятность возникновения чрезвычайной ситуации и работоспособность может быть полностью потеряна.

    Записываются всегда, отключить запись событий данного уровня в ручную невозможно.

    Чрезвычайная ситуация — EMERGENCY (600)

    Работоспособность системы нарушена полностью. Работа невозможна. Требуется вмешательство специалистов по устранению возникших проблем.

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

    Примечания

    Файлы журналов занимают место и поэтому рекомендуется включить ограничения на максимальный размер файлов и максимальное количество файлов.

    Так же стоит периодически проверять журналы событий на предмет каких либо проблем во избегании чрезвычайной ситуации.

    Типы данных: Журналы