Документация1С-Битрикс: Модулиnative.api

События модуля

Раздел «Сервисы → API-платформа → События модуля» открывает системный журнал событий платформы с фильтром по модулю. Здесь можно проследить изменения настроек, операции с токенами и причины ошибок при работе API.

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

Данные входящих запросов и ответов просматриваются отдельно — в списках и карточке запроса. Их основные флажки на вкладке «Логирование» сохраняют данные в таблицах модуля, а не в этом системном журнале.

Запись и доступ

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

Право чтения журналов в модуле показывает пункт меню, а для просмотра записей нужен отдельный доступ к системному журналу событий платформы. Подробнее — в разделе «Доступ».

Типы событий

Настройки и работа API

СобытиеНазначение
Изменение настроек модуляПроверить, какие настройки были изменены
Очистка кеша модуляНайти выполнение действия «Очистить кеш»
Ошибка запуска модуляИзучить ошибки, зарегистрированные при обработке API-запроса

Название «Ошибка запуска модуля» используется и для ошибок обработки запросов, например неверной авторизации или отсутствующего роута. Смотрите код и описание конкретной записи, а не только название типа события.

Токены

СобытиеНазначение
Создание токенаНайти добавление записи access- или refresh-токена
Изменение токенаСравнить изменённые значения до и после сохранения
Удаление токенов клиентаНайти отзыв токенов клиента через API
Смена ключа шифрования токеновУстановить момент генерации нового ключа в настройках

Одна пара состоит из двух записей, поэтому её выпуск создаёт отдельные события для каждого токена. Событие «Удаление токенов клиента» относится к отзыву через API; оно не является журналом каждого удаления строки из административного списка.

Действия с токенами описаны в разделе «Токены авторизации».

Обработчики событий

Событие «Вызов пользовательского обработчика» помогает разобрать работу расширений модуля: какое событие обрабатывалось, какие обработчики вызывались и как изменились данные. Запись включается флажком «Логировать пользовательские обработчики».

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

Поиск причины ошибки

  1. Выберите период и тип события. При необходимости уточните пользователя или IP-адрес.
  2. Сопоставьте время записи с запросом клиента или действием администратора.
  3. Изучите описание: для ошибки оно может содержать код, HTTP-статус и сообщение, для изменения — значения полей до и после операции.
  4. Исправьте причину и повторите действие.

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

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