SolverWeb Logger

Технические данные

Совместимые редакции

• Программа для ЭВМ "1С-Битрикс: Управление сайтом". Лицензия Старт
• Программа для ЭВМ "1С-Битрикс: Управление сайтом". Лицензия Стандарт
• Программа для ЭВМ "1С-Битрикс: Управление сайтом". Лицензия Малый бизнес
• Программа для ЭВМ "1С-Битрикс24". Лицензия Стандартный (12 мес.)
• Программа для ЭВМ "1С-Битрикс: Управление сайтом". Лицензия Бизнес
• Программа для ЭВМ "1С-Битрикс24". Лицензия Интернет-магазин + CRM (12 мес.)

Описание

Это журнал событий для Bitrix-сайта с нормальной админкой и уведомлениями. Его можно вызывать из своего кода буквально в пару строк:

 CModule::IncludeModule('solverweb.logger');

 $logger = \SolverWeb\Logger::Space('login');
 $logger->log('Название', 'test');

 После этого появится запись в пространстве login. Пространство - это просто отдельный журнал для конкретной части сайта: login, Git, Exceptions, telegram или любое своё название. Значение можно передать строкой, массивом
 или объектом. Модуль сохранит массив и объект в JSON, так что в логах не будет унылого Array.

 У записи есть пять уровней: info, warning, error, fatal и success. В админке пространства видны отдельно: ошибки подсвечены, записи можно фильтровать по уровню и названию, очистить журнал или удалить пространство
 целиком.

 Модуль умеет собирать несколько системных событий:

 - входы выбранных пользователей в Bitrix;
 - необработанные PHP-исключения из файла, указанного в .settings.php;
 - изменение Git HEAD;
 - появление незакоммиченных файлов;
 - зависшие почтовые события Bitrix.

 Для исключений и повторяющихся событий есть защита от дублей через SHA-1-хеш. Например, один и тот же фрагмент error-лога не будет записываться снова и снова. Файл исключений модуль читает частями, не пытаясь заглотить
 его целиком.

 У каждого пространства можно настроить доставку по уровням: на email и в Telegram. Реквизиты Telegram разрешено задать один раз в общих настройках. Если в конкретном space поля пустые, он возьмёт общие Chat ID, токен,
 прокси и шаблон. Прокси задаётся одной строкой, поддерживаются http://, https:// и socks5://, включая логин и пароль в URL.

 Отправка уведомлений не тормозит сайт. Вызов log() сразу сохраняет запись и ставит доставку в очередь. Дальше минутный агент Bitrix отправляет сообщения в фоне. При сбое он повторяет попытки с паузами 1, 5, 15, 60 и 360
 минут, а затем помечает задачу как ошибочную. В настройках space видно состояние очереди, последнюю ошибку и время работы агента.

 Есть режим отладки Telegram. Когда он включён, модуль создаёт space telegram и пишет туда попытки отправки, ответ API, ошибки и параметры соединения с прокси. Эти технические записи не отправляются обратно в Telegram,
 поэтому петли не будет.

 По умолчанию логи хранятся 30 дней. Для отдельного space можно назначить свой срок. Отправленные задания очереди чистятся через неделю.

 Для фоновой работы агенты Bitrix должны запускаться через cron. Без этого уведомления останутся в очереди, а проверки Git и исключений будут стоять на месте.