Download the PHP package itrukhin/bxmonolog without Composer
On this page you can find all versions of the php package itrukhin/bxmonolog. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download itrukhin/bxmonolog
More information about itrukhin/bxmonolog
Files in itrukhin/bxmonolog
Package bxmonolog
Short Description Monolog logger for 1C-Bitrix
License MIT
Homepage https://github.com/itrukhin/bxmonolog.git
Informations about the package bxmonolog
Адаптер Monolog для 1С-Битрикс
Адаптер позволяет организовать запись и хранение файлов логов в Битриксе. Основные возможности:
- Хранение всех логов в выделенной специальной папке на сервере
- Автоматическое создание вложенных папок для группировки файлов логов
- Ошибки ядра 1С-Битрикс пишутся во вложенную папку bitrix, которую можно переназначить
- Каждый день логи пишутся в отдельный файл вида YYYY-MM-DD.log
- Автоматическое удаление файлов логов старше N дней
- Конфигурирование через глобальные переменные $_ENV, например с помощью Dotenv
- Аварийный лог inner_error.log для ошибок самого логгера
Установка
Предполагается, что у вас Битрикс уже умеет работать с автозагрузкой composer
Настройка .settings.php
Настройки окружения
- APP_DEBUG - включить/выключить отладку, используется только в
.settings.php
- APP_DEBUG_LEVEL - минимальный уровень, для которого будет выполняться запись в лог. По умолчанию
DEBUG
, это значит, что будут выводиться все ошибки. Можно на проде, например, ограничить уровнемERROR
- APP_LOG_FOLDER - папка логов, относительно
DOCUMENT_ROOT
. По умолчанию/log/
- APP_LOG_BITRIX_CHANNEL - подпапка логов по умолчанию. Если не задано, будет создана папка
bitrix
, относительноAPP_LOG_FOLDER
. Для записи своих логов рекомендуется явно указывать папку, так как в папкуbitrix
будут записываться ошибки ядра.
Примеры использования
Код примеров есть в папке examples
При настроенном .settings.php
(см. выше) все ошибки битрикса будут записываться в файл
что, по умолчанию, соответствует пути /log/bitrix/
от корня сервера. Ошибки ядра имеют уровень CRITICAL
Для записи произвольных логов необходимо вначале создать экземпляр объекта лога
где test - имя папки, относительно APP_LOG_FOLDER
, в которую будут писаться логи. Подапка, при ее отсутствии, будет создана автоматически. По возможности, будут установлены аттрибуты BX_DIR_PERMISSIONS
Далее для каждого уровня лога может быть вызван одноименный метод, например:
В результате мы получаем файлы логов с отформатированным содержимым, пример:
Отправка ошибок в Telegram
Для оперативной реакции на ошибки, необходимо узнавать о них сразу, как только они возникли. Одним из удобных способов является отправка ошибок в чат Telegram. О возникновении ошибки на сайте немедленно будут проинформированы все участники чата.
Настройка Telegram
Необходимо создать бота в телеграм с помощью @BotFather. Для бота мы получим
API Token вида 000000000:XXXXXXXXXXXXXXXXXXXX
. Далее нужно создать чат, в который бот будет писать сообщения, и добавить бота администратором в этот чат.
Второй параметр, который нам необходимо получить - это ChatID. Получить его можно выполнив запрос вида https://api.telegram.org/botXXX:YYYYY/getUpdates
,
где XXX:YYYYY
- это API Token бота. В ответ будет json, из которого нужно получить ChatID.
Пример ответа
нас интересует "chat":{"id":-1001202656383,"title"... ChatID это -1001202656383
Настройка BxMonolog
За настройку параметров отправки сообщений в Telegram отвечают следующие параметры $_ENV
- APP_LOG_TELEGRAM - включить/выключить отправку в Telegram. Должно быть установлено в 1, или true, или on
- APP_LOG_TELEGRAM_KEY - API Token бота
- APP_LOG_TELEGRAM_CHATID - ChatID
Отправка в Telegram
Для отправки сообщение в телеграм, реализован метод telegram, аналогичный методу log в PSR-3
Результатом будет запись ошибки в лог и сообщение в Telegram, начинающееся с my code error и содержащее текст ошибки, имя файла. Также можно писать любой текст. По умолчанию включен формат отправки HTML, включены уведомления, отключена ссылка на просмотр сообщения в вебе. Указывать source не обязательно.
Настройки, которые можно передавать через массив context
- source - начало сообщения в Telegram
- parse_mode - по умолчанию HTML, но может быть null, Markdown, MarkdownV2
- disable_notification - boolean, по умолчанию false
- disable_preview - boolean, по умолчанию true
Также можно получить экземпляр логгера, с настройками по умолчанию, только для отправки сообщений в Telegram
Очистка логов
Для периодической очистки логов можно использовать метод
Который будет удалять файлы логов старше 15 дней. Метод возвращает строку вызова самого себя, поэтому может быть добавлен в агенты Битрикса.