Мониторинг ошибок

Установка

Установите решение из Маркетплейса и дождитесь окончания установки.

Выдайте права группе, которая будет работать с модулем: «Настройки» — «Пользователи» — «Группы пользователей» — нужная группа — вкладка «Доступ» — модуль «Мониторинг ошибок».

• «Чтение» — меню, журнал, очередь и просмотр настроек.
  
• «Запись» — изменение настроек, чат, вебхуки, синхронизация и действия в очереди.
  

Откройте «Бестранк» — «Мониторинг ошибок» — «Настройки».

После установки сбор PHP- и JS-ошибок включён, рассылка тоже включена. Ошибки сразу пишутся в журнал. Сообщение в чат уходит только после того, как появится получатель: чат с ботом, если чат поддерживается, или входящий вебхук.

Журнал PHP

Ошибки PHP читаются из файлового журнала исключений. В уже существующей секции exception_handling файла /bitrix/.settings.php или /bitrix/.settings_extra.php укажите файл лога. Секцию целиком не заменяйте, если в ней уже заданы типы ошибок. Класс журнала оставьте стандартным или не задавайте его: модуль ожидает Bitrix\Main\Diag\FileExceptionHandlerLog.

Файл должен уже существовать и быть доступен на чтение пользователю веб-сервера. Модуль файл не создаёт и не очищает. Путь показан в настройках в поле «Файл PHP-лога». Если файл не настроен или недоступен, PHP-ошибки из лога не собираются. JS-ошибки при этом собираются.

Фрагмент настроек:

'exception_handling' => [
   'value' => [
       'debug' => false,
       'log' => [
           'settings' => [
               'file' => 'bitrix/modules/error.log',
               'log_size' => 1000000,
           ],
       ],
   ],
   'readonly' => false,
],

Путь относительно корня сайта или абсолютный. Каталог bitrix/modules/ для файла должен быть доступен на запись, если включена ротация по log_size.

Чат и бот

Блок «Чат и бот» зависит от модуля «Веб-мессенджер». Если чат на портале поддерживается, нажмите «Создать чат и бота». Появится закрытый чат и бот. Откройте чат и добавьте сотрудников, которые должны получать сообщения. Флажок «Активен» оставьте включённым.

Если чат не поддерживается, в этом блоке показано предупреждение «Чат-бот не поддерживается». Журнал при этом ведётся как обычно, кнопка создания чата недоступна.

Кнопка «Удалить чат и бота» убирает чат вместе с ботом. Сообщения этого чата пропадут.

Вебхуки

Входящий вебхук — отдельный способ отправить то же короткое сообщение в диалог. Он доступен и тогда, когда бот на портале не поддерживается. Укажите URL входящего вебхука и диалог, например chat123. Строка сохраняется, только если заполнены оба поля. Если в URL нет im.message.add, модуль допишет метод сам. У каждого вебхука свой диалог. Последняя ошибка отправки показывается в строке вебхука.

Сбор

• «Рассылка включена» — при выключенной рассылке агент пишет ошибки в журнал и сообщения не отправляет.
  
• «Фиксировать PHP-ошибки» и «Фиксировать JS-ошибки» можно выключить по отдельности.
  
• «Период рассылки, минут» — как часто запускается агент. По умолчанию 15, допустимо от 1 до 1440.
  
• «Ошибок в одном сообщении» — от 1 до 50, по умолчанию 10.
  
• «Глубина PHP-лога, дней» — от 0 до 90, по умолчанию 1. Ноль — читать лог с момента включения сбора PHP.
  
• «Хранить записи, дней» — по умолчанию 30. Ноль — не удалять. Агент удаляет ошибки, у которых последний повтор старше этого срока.
  
• «Не отправлять в чат» — по одной маске в строке. Обычная строка ищется как фрагмент текста без учёта регистра в типе, сути, месте и полном тексте. Строка вида /шаблон/ или #шаблон# — регулярное выражение, в конце можно указать флаги i, m, s, u. Строка, которая начинается с //, — комментарий. Путь со слэшами пишите обычным текстом или оберните в решётки: конечный слэш превратит строку в выражение.
  

Ограничения отправки

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

• «Пауза между сообщениями бота, секунд» — по умолчанию 15.
  
• «Не больше сообщений бота в минуту» — по умолчанию 4.
  
• «Не повторять ту же ошибку ботом, минут» — по умолчанию 6.
  

Синхронизация

Кнопка «Синхронизировать ошибки» забирает PHP-ошибки из лога за число дней из поля «Глубина PHP-лога» и записывает их в журнал. Сообщения уходят только если включена рассылка, отмечено «Отправить сообщения» и есть чат с ботом или вебхук.

Агент

Один агент читает PHP-лог, при наличии получателя рассылает очередь и удаляет записи журнала старше срока хранения. На странице настроек есть интервал, время следующего запуска и ссылка «Открыть агент».

Ошибки JavaScript

Собираются на обычных HTML-страницах, пока включено «Фиксировать JS-ошибки». В сбор не попадают командная строка PHP, REST, адреса /bitrix/services/, /bitrix/tools/ и /desktop_app/.

Очередь

«Бестранк» — «Мониторинг ошибок» — «Очередь». Здесь ошибки со статусом «Не отправлено». При праве «Запись» доступны действия «Снять с очереди», «Отметить отправленными» и «Очистить очередь». Они сообщение не отправляют: запись уходит из очереди или помечается отправленной.

Удаление

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

По вопросам технической поддержки обращайтесь на email info@bestrank.ru

Поддержка осуществляется по будням с 9:00 до 18:00 по московскому времени. Скорость ответа зависит от загруженности команды и сложности вопроса, но в среднем составляет 1-3 рабочих дня.