Логирование работы модуля
Общее
Для контроля работы модуля и своевременного выявления ошибок предусмотрена гибкая система логирования, фиксирующая все ключевые процессы.
Доступ к журналу логов и настройки логирования находятся в разделе «Журнал обмена» в настройках модуля:
С помощью настроек в данном разделе можно управлять объёмом сохраняемой информации и настраивать срок хранения логов.
Логи работы модуля сохраняются в отдельные файлы и условно делятся на два типа:
- Основные логи — содержат ключевую информацию, необходимую для общего контроля процесса синхронизации;
- Детальные логи — включают расширенные данные, используемые для диагностики и отладки.
Детальные логи рекомендуется включать только при необходимости, так как при длительной работе они могут занимать значительный объём дискового пространства.
В логах также могут содержаться дополнительные ссылки на файлы с расширенной информацией по отдельным операциям. Эти файлы формируются автоматически в процессе работы модуля и позволяют более детально проанализировать выполнение конкретных процессов.
Контролировать объём основных и детальных логов можно с помощью соответствующих настроек хранения.
Для этого предусмотрены два параметра:
- Сколько дней хранить основные логи:
- Сколько дней хранить детальные логи:
В этих полях указывается количество дней, в течение которых логи будут сохраняться. По истечении указанного срока устаревшие логи автоматически удаляются.
Также в настройках модуля можно полностью отключить сбор детальных логов:
Кроме этого, логи разделены на отдельные категории — всего доступно 10 типов, соответствующих различным процессам и сущностям. В каждой категории доступны как основные, так и детальные логи.
Выбрать нужную категорию для просмотра можно с помощью выпадающего списка, в котором представлены все доступные типы логов:
В блоке просмотра логов доступны инструменты для управления отображением:
-
Календарь — позволяет выбрать дату, за которую будут отображаться основные или детальные логи:
-
Кнопка «Скачать» — позволяет выгрузить лог-файл за выбранную дату:
-
Кнопка «Обновить» — используется для подгрузки актуальных данных логов без перезагрузки страницы.
-
Переключатель режима — позволяет выбрать тип отображаемых логов: основные или детальные.
Также важно учитывать, что вся информация из основных логов полностью дублируется в детальных логах, при этом детальные логи дополнительно содержат расширенные данные для отладки.
Сохранение отладочной информации о запросах к МойСклад
Иногда для более точной настройки модуля и контроля обращений к МойСклад требуется дополнительная информация о выполненных запросах, а также об отправленных и полученных заголовках.
Для этого в модуле предусмотрена отдельная настройка — «Сохранять в детальных логах полную статистику по запросам в МойСклад»:
Если опция отключена, в детальных логах будет сохраняться только общая информация о количестве и типах запросов. Данные о заголовках запросов и ответов при этом фиксироваться не будут.
Контроль размера и очистка логов
Файлы логов для разных процессов могут занимать различный объём. При большом количестве сущностей и операций размер логов может существенно увеличиваться, что влияет на использование дискового пространства.
Для контроля объёма логов предусмотрено несколько механизмов:
- настройка срока хранения логов (количество дней), после которого старые записи автоматически удаляются;
- дополнительные инструменты ручного управления логами.
В разделе «Журнал обмена» доступна вкладка «Управление логами»:
Используя эту вкладку можно:
- удалять основные и детальные логи по отдельным процессам и сущностям;
- вручную очищать неиспользуемые логи для освобождения места на диске;
- использовать фильтр для просмотра объёма логов за определённый период и последующего удаления.
Также важно учитывать, что помимо настроек хранения и ручного управления логами, в модуле реализован дополнительный механизм автоматической очистки.
Если общий размер логов превышает 1 ГБ, запускается автоматическая очистка части файлов.
Данный механизм работает через отдельный агент, который выполняется один раз в день и контролирует общий объём логов, при необходимости уменьшая его.