Логирование (ведение журналов)

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

Структура создания журналов

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

Основной плагин

При загрузке плагина, до момента инициализации настроек плагина, запись производится в файл wc1c.boot.log расположенный в корневой директории для загрузки файлов WordPress. Данный файл должен быть всегда пустым. Если там появляются ошибки, значит с окружением плагина что то не то. Подробнее будет указано об ошибках именно в этом файле.

После инициализации настроек плагина, уровень записи ошибок устанавливается исходя из настроек, а сам файл журнала помещается в основную директорию загрузки файлов плагина. При этом название журнала становится wc1c.main.log

Схемы

У схем совершено другое расположение файлов логов. Файлы логов размещаются в главных директориях конфигураций, которые имеют в названии идентификатор схем + идентификатор конфигурации. Сам файл лога имеет название main.log

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

Уровни записи

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

Выключен

Скорее не уровень, а флаг полного отключения логирования. Не рекомендуется использовать отключение. В данном случае невозможно будет детектировать ошибки.

Отладка (100)

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

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

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

Уведомления (250)

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

Ошибки (400)

Критические ошибки (500)

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

Тревога (550)

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

описание дорабатывается

скоро будет доступно