Журналы событий

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

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

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

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

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

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

Расположение журналов

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

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

Уровень записи основных событий устанавливается исходя из настроек произведенных в основных настройках плагина на вкладке Журналы событий. Рекомендуется использовать уровень не менее чем замечания и категорически не рекомендуется использовать уровни Отладка и Информация на работающем сайте, т.к. они созданы для разработчиков и администраторов.

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

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

Расположение журналов

Файлы журналов событий в инструментах располагаются в путь_до_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)

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

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

События записываются так, что при выборе уровня Отладка, будут записаны события всех высших уровней. При выборе уровня Предупреждение, будут записаны все события уровней: Предупреждение, Ошибка, Критический, Тревога, Чрезвычайная ситуация.

Просмотр журналов событий

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

Для просмотра конфигураций имеется два варианта 1. Бесплатный, 2. Платный.

Бесплатный

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

Платный

Для просмотра журналов через панель управления существуют расширения. Технически подкованным в этом случае можно не быть. Просмотр и управление журналами происходит в панели WordPress в максимально удобном виде: https://wc1c.info/extensions/logs