Bitrix логирование ошибок php

Основное предназначение модуля — быстрое оповещение о случивших на сайте проблемах. Для этого существуют сервисы (агенты), следящие за ошибками (чтение изменений в логах, прямой отлов ошибок в PHP), и сервисы, отправляющие оповещения на e-mail, либо в браузер доверенному лицу.

Для экономии места и удобства работы записываются только уникальные ошибки. У них обновляются дата последнего возникновения и количество повторов.

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

Сохраняемые данные

Поиск по логам

Поиск можно делать по полям: дата последнего возникновения, тип ошибки, текст ошибки, источник (по данным из какого файла искать).

Если заполнены все поля, запрос поиска можно представить так:

SELECT * FROM `logs`
WHERE
`last_date` >= $lastDate
AND `type` IN ("@type1","@type2")
AND (`message` LIKE "%$text%" OR `trace` LIKE "%$text%")
AND `file_id` IN (@fileId1, @fileId2)

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

Подключение обработчика ошибок PHP

Используется стандартный механизм Битрикс. Логгер будет вызван функциями set_error_handler,
set_exception_handler, register_shutdown_function

Чтобы подключить логгер нужно прописать настройки в файле bitrix/.settings.php в секции exception_handling

'exception_handling' => array(
        'value' => array(
            'debug' => false,
            'handled_errors_types' => E_ALL & ~E_NOTICE & ~E_WARNING & ~E_STRICT & ~E_USER_WARNING & ~E_USER_NOTICE & ~E_COMPILE_WARNING & ~E_DEPRECATED,
            'exception_errors_types' => E_ALL & ~E_NOTICE & ~E_WARNING & ~E_STRICT & ~E_USER_WARNING & ~E_USER_NOTICE & ~E_COMPILE_WARNING & ~E_DEPRECATED,
            'ignore_silence' => false,
            'assertion_throws_exception' => true,
            'assertion_error_type' => 256,
            'log' => array(
                'class_name' => 'BxSolAchtungProExceptionsHandlerLogger',
                'required_file' => 'modules/bxsol.achtungpro/lib/ExceptionsHandler/Logger.php',
                //либо
                'required_file' => 'modules/bxsol.achtungpro/lib/ExceptionsHandler/LoggerOld.php',
            ),
        ),
        'readonly' => false
    ),

Битрикс меняли формат ExceptionsHandler, поэтому реализовано 2 варианта логгера, точные настройки есть на странице настройки модуля. Читать подробнее об обработке ошибок в Битрикс.

Чтение файлов логов

В настройках модуля нужно просто указать абсолютный путь к файлу. Поддерживаемые типы: PHP Error log, TimeWeb error log, Apache error log.

Форматы лог файлов

Php error log

[29-May-2016 22:32:39 Europe/Moscow] PHP Fatal error: error message

Apache Error log

[29-May-2016 22:32:39 Europe/Moscow] [php fatal error] error message

Time Web Error Log

[Mon May 02 07:23:29 2016] [error] [client **.***.**.**] Error_Type Error_Message

Ведется работа над чтением логов любого формата.

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

Агенты

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

Агент анализа файлов:

[АБСОЛЮТНЫЙ_ПУТЬ_НА_СЕРВЕРЕ]/bitrix/modules/bxsol.achtungpro/cron/FilesListener.php

Агент отправки писем:

[АБСОЛЮТНЫЙ_ПУТЬ_НА_СЕРВЕРЕ]/bitrix/modules/bxsol.achtungpro/cron/EmailSender.php

В данных файлах требуется указать значение переменной $_SERVER['DOCUMENT_ROOT']

Логгер для разработчиков

Вместе с модулем поставляется логгер, который можно легко использовать для своих нужд. Например, отправлять оповещения, что выгрузка в Яндекс.Маркет прошла успешна, либо наоборот.

При этом вы получите уведомление на почту или сразу в браузер, если в данный момент находитесь сайте. Держите процессы на сайте под полным контролем!

use BxSolAchtungProLogger;

CModule::IncludeModule('bxsol.achtungpro');
Logger::info('Yandex market uploading done');

Если нет желания запускать полную инициализацию модуля, достаточно подключить файл логгера.

use BxSolAchtungProLogger;

require_once $_SERVER['DOCUMENT_ROOT'].'/bitrix/modules/bxsol.achtungpro/lib/Logger.php';
Logger::info('Yandex market uploading done');

Впрочем для аккаунта разработчика модуль подключается всегда, т.к. отпраляются оповещения в браузер об ошибках.

Общий синтаксис

class Logger
{
 ...
    /**
     * @param string $message - сообщение
     * @param string $type - уровень (notice, warning)
     * @param bool $withTrace - записывать трейс или нет. Причем вызов логгера будет удалён из трейса.
     */
    public static function log($message, $type, $withTrace = true)
 ...
}

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

Функции краткого вызова

Альтернативные события

Полный список возможных типов (уровней) ошибок

Ошибки с кратким вызовом (Logger::info() и т.д.):

• Logger::CRIT
• Logger::DEBUG
• Logger::DEPRECATED
• Logger::FATAL
• Logger::INFO
• Logger::NOTICE
• Logger::INFO
• Logger::MIRACLE
• Logger::SHIT_HAPPENS
• Logger::VOVA_POMOGI

Остальные типы:

• Logger::ALL
• Logger::COMPILE_ERROR
• Logger::COMPILE_WARNING
• Logger::CORE_ERROR
• Logger::CORE_WARNING
• Logger::DB_ERROR
• Logger::ERROR
• Logger::PARSE
• Logger::RECOVERABLE_ERROR
• Logger::UNCATCHABLE_EXCEPTION
• Logger::USER_DEPRECATED
• Logger::USER_ERROR
• Logger::USER_NOTICE
• Logger::USER_WARNING

1. Создаю в корне сайта файл error.php со следующим содержимым:

<?php
echo show_me_error;
?>

2. Открываю в браузере site.ru/error.php — белый экран

3. Смотрю bitrix/php_interface/dbconn.php:
$DBDebug = true;

4. Смотрю bitrix/php_interface/.settings.php:

...
  array (
    'value' => 
    array (
      'debug' => true,
      'handled_errors_types' => E_ALL & ~E_NOTICE & ~E_STRICT & ~E_USER_NOTICE & ~E_DEPRECATED,
      'exception_errors_types' => E_ALL & ~E_NOTICE & ~E_WARNING & ~E_STRICT & ~E_USER_WARNING & ~E_USER_NOTICE & ~E_COMPILE_WARNING,
      'ignore_silence' => true,
      'assertion_throws_exception' => false,
      'assertion_error_type' => 256,
      'log' => array (
        'settings' => array (
        'file' => 'bitrix/modules/error.log',
        'log_size' => 1000000,
        ),
      ),  
    ),
    'readonly' => false,
  ),
...

5. Смотрю bitrix/modules/error.log — кучу левых Warning, однако моей ошибки в моём error.php нет
6. Иду в .htaccess:

php_value display_errors 1
php_value error_reporting 7

7. Иду на сервере в /var/log/nginx/error.log — то же самое, ничего о моей ошибке

Как мне на экране при открытии error.php увидеть мою ошибку?

Объяснять, что такое логи — нет необходимости. Когда есть логи, то проще разобраться с возникшими проблемами и выяснить, почему они начались. Основные моменты в использовании логов.

Логи не должны занимать всё свободное пространство на диске, т.е. в логи нужно помещать только нужную информацию, а не всё подряд. Устаревшие логи должны удаляться. Для удаления устаревших логов лучше всего настроить задание на cron.

Логи должны быть удобными для изучения — логи с ошибками и логи с диагностическими данными должны помещаться в разные файлы. Желательно разделять логи на временные интервалы — например, ежедневные логи (наиболее распространенный вариант, или, например, по месяцам, или неделям).

Все логи нужно держать в одной папке, чтобы было удобней их изучать (/logs/, /_logs/, /local/logs/ и т.п. ). В целях защиты следует закрыть доступ к папке с логами по http — настраивается в .htacces,

deny from all

и/или добавить к названию файла уникальный идентификатор.

Папку для логов надо предварительно создать и убедиться, что битрикс (веб-сервер) имеет права на запись в нее.

В системе 1С-Битрикс существует 2 вида логов:

ADDMESSAGE2LOG(…)

Это функция из старого ядра. Многие модули пишут через нее отладочную информацию.

Пример настройки места хранения логов, выводимых данной функцией, выглядит так (папка logs/bx должна быть создана):

define("LOG_FILENAME", $_SERVER["DOCUMENT_ROOT"] . "/logs/bx/" . date("Y-m-d") . ".log");

Прописать данную настройку можно, например, в dbconn.php.

СЕКЦИЯ EXCEPTION_HANDLING В ФАЙЛЕ .SETTINGS.PHP

Это уже функционал нового ядра D7.

Битрикс через данный функционал пишет информацию обо всех ошибках и исключениях. Что именно пишется — зависит от настроек.

Пример настройки логов с разделением по дате:

'exception_handling' => array (
  'value' => array (
      'debug' => false, // disables error output to screen
       // ошибки для вывода в лог
      'handled_errors_types' => E_ALL & ~E_NOTICE & ~E_STRICT & ~E_WARNING,
      'exception_errors_types' => E_ALL & ~E_NOTICE & ~E_WARNING & ~E_STRICT & ~E_COMPILE_WARNING,
      'ignore_silence' => true,
      'assertion_throws_exception' => true,
      'assertion_error_type' => 256,
      'log' => array (
          'settings' => array (
              'file' => "logs/bx_error/" . date("Y-m-d") . ".log",
			  'log_size' => 1000000, // ~ 1Mb per file
          ),
      ),
  ),
  'readonly' => true,
),

ФУНКЦИИ ОТЛАДКИ В ЯДРЕ D7

На замену функции AddMessage2Log в ядре D7 пришли новые функции:

use BitrixMainDiagDebug;
Debug::dumpToFile($_SERVER); // для случаев, когда нужен var_dump
Debug::writeToFile($_SERVER); // когда нужен print_r

Также в ядре D7 появились методы, для измерения времени. В старом ядре аналогов не было.

use BitrixMainDiagDebug;
Debug::startTimeLabel("foo");
foo();
Debug::endTimeLabel("foo");

Debug::startTimeLabel("bar");
bar();
Debug::endTimeLabel("bar");

print_r(Debug::getTimeLabels());

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

Думаю, объяснять, что такое логи — нет необходимости. Имея под рукой логи проще разобраться с возникшими проблемами и выяснить, когда и почему они начались. В данной статье расскажу основные моменты в использовании логов.

Для начала обсудим важный, но не для всех явный момент — логи полезны только в том случае, если с ними удобно работать. 

Поэтому логи не должны занять все свободное пространство на диске, т.е. в логи нужно помещать только нужную информацию, а не все подряд. Устаревшие логи должны удаляться. Для удаления устаревших логов лучше всего настроить задание на cron.

Логи должны быть удобными для изучения — логи с ошибками и логи с диагностическими данными должны помещаться в разные файлы. Желательно разделять логи на временные интервалы — например, ежедневные логи (наиболее распространенный вариант, но если уверены, что логов будет мало — можно выделять, например, по месяцам, или неделям).

Все логи нужно держать в одной папке, чтобы было удобней их изучать (/logs/, /_logs/, /local/logs/ и т.п. ). В целях защиты следует закрыть доступ к папке с логами по http — настраивается в .htacces, 

deny from all

и/или добавить к названию файла уникальный для проекта постфикс.

Папку для логов надо предварительно создать и убедиться, что битрикс (веб-сервер) имеет права на запись в нее.

В системе 1С-Битрикс существует 2 вида логов

AddMessage2Log(…)

Это функция из старого ядра.
Многие модули пишут через нее отладочную информацию.

Пример настройки места хранения логов, выводимых данной функцией, выглядит так (не забывайте, что папка logs/bx должна быть создана):

define("LOG_FILENAME", $_SERVER["DOCUMENT_ROOT"] . "/logs/bx/" . date("Y-m-d") . ".log");

Прописать данную настройку можно, например, в dbconn.php.

Секция exception_handling в файле .settings.php

Это уже функционал нового ядра.

Ядро через данный функционал пишет информацию обо всех ошибках и исключениях. Что именно пишется — зависит от настроек.

Пример настройки логов с разделением по дате:

'exception_handling' => array (
  'value' => array (
      'debug' => false, // disables error output to screen
       // ошибки для вывода в лог
      'handled_errors_types' => E_ALL & ~E_NOTICE & ~E_STRICT & ~E_WARNING,
      'exception_errors_types' => E_ALL & ~E_NOTICE & ~E_WARNING & ~E_STRICT & ~E_COMPILE_WARNING,
      'ignore_silence' => true,
      'assertion_throws_exception' => true,
      'assertion_error_type' => 256,
      'log' => array (
          'settings' => array (
              'file' => "logs/bx_error/" . date("Y-m-d") . ".log",
			  'log_size' => 1000000, // ~ 1Mb per file
          ),
      ),
  ),
  'readonly' => true,
),

Функции отладки в ядре D7

На замену функции AddMessage2Log в ядре D7 пришли новые функции:

use BitrixMainDiagDebug;
Debug::dumpToFile($_SERVER); // для случаев, когда нужен var_dump
Debug::writeToFile($_SERVER); // когда нужен print_r

Также в ядре D7 появились методы, для измерения времени. В старом ядре аналогов не было.

use BitrixMainDiagDebug;
Debug::startTimeLabel("foo");
foo();
Debug::endTimeLabel("foo");

Debug::startTimeLabel("bar");
bar();
Debug::endTimeLabel("bar");

print_r(Debug::getTimeLabels());

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

Нужно включить показ ошибок bitrix/www/bitrix/.settings.php

‘debug’ => true,

тоже самое с базой данных .

bitrix/www/bitrix/php_interface/dbconn.php

Также можно заменить ‘log’ => null на

'log' => 
      array (
        'settings' => 
        array (
          'file' => '/var/log/php/exceptions.log',
          'log_size' => 1000000,
        ),
      ),

По умолчанию в конфигурации Битрикс отключено логирование ошибок. Для записи ошибок в лог добавляем в файл конфигурации bitrix/.settings.php  секцию:

<?php

'exception_handling' =>

array (

'value' =>

array (

'debug' => true,

'handled_errors_types' => E_ALL & ~E_NOTICE & ~E_STRICT & ~E_USER_NOTICE & ~E_DEPRECATED,

'exception_errors_types' => E_ALL & ~E_NOTICE & ~E_WARNING & ~E_STRICT & ~E_USER_WARNING & ~E_USER_NOTICE & ~E_COMPILE_WARNING,

'ignore_silence' => false,

'assertion_throws_exception' => true,

'assertion_error_type' => 256,

'log' =>        array (         'settings' =>          array (           'file' => 'bitrix/err.log',           'log_size' => 1000000,         ),       ),     ),     'readonly' => false,   ),

?>

Формат ужасный, но другого нет 🙂