intensa.logger

KO | EN

gitlite — search

#hacktoberfest #go #android #rust #linux #docker #macos #windows #kubernetes #awesome-list #pytorch #security #mcp #open-source

(★ 8)

No description available.

intensa.logger Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Intensa Logger

![logo.svg](https://raw.githubusercontent.com/intensa/intensa.logger/master/images/logo.svg)

Простой и функциональный модуль CMS Bitrix для логгирования данных проекта в файлы.

Модуль можно использовать для логирования "узких" мест в проекте и дебага при разработке.

Логгер реализует интерфейс \Psr\Log\LoggerInterface [PSR-3](https://www.php-fig.org/psr/psr-3/).

В модуле реализовано:
- Запись логов в файлы
- Оповещение о критических проблемах в проекте
- Очищение устаревших лог-файлов
- Таймеры выполнения
- SQL трекер на основе diag

## 🔴 Миграция со старых версий!🔴
При переходе на версии 2.0.0 и выше необходимо выполнить:

- Изменить класс логгера с `ILog` на `Logger`
- Все места вызова метода `log` заменить на `info`
- Все места вызова метода `fatal` заменить на `emergency`
- Убедиться что в контексте логирования передается массив
- Убрать вызовы методы `setAdditionalEmail()`

Рекомендуем проводить миграцию версии на тестовом или локальном окружении.

## Установка модуля

Самый простой способ добавить модуль в свой проект - это выполнить установку через маркетплейс [http://marketplace.1c-bitrix.ru/solutions/intensa.logger/](http://marketplace.1c-bitrix.ru/solutions/intensa.logger/).

Также возможно установить модуль вручную. Для этого нужно:
1. Клонировать репозиторий в директорию с модулями `/bitrix/modules/` или `/local/modules/`
2. Перейти в директорию `intensa.logger/lib` (команда `cd intensa.logger/lib`)
3. Установить зависимости `composer install --no-dev`
4. Выполнить установку модуля через админ часть сайта `/bitrix/admin/partner_modules.php`

При установке модуль создает:

- Защищённую директорию `/logs/`  в корне проекта. Используется для хранения лог-файлов
- Почтовое события для оповещений фатальных уровней логгирования
- Агент для удаления устаревших лог-файлов

## Хранилище логов

По умолчанию хранилищем лог-файлов является директория /logs/ в корне проекта. При необходимости в настройках модуля можно изменить данное значение. Защита логов от просмотра в браузере реализована через файл .htaccess

> В проектах, использующих в качестве веб-сервера nginx, необходимо обезопасить хранилище самостоятельно - закрыв директорию от просмотра в браузере в конфигах nginx или же изменить пути хранилища логов (вынести хранилище из document_root).
>

Для удобства хранения и доступа к файлам логов реализован функционал хранения по дням.

Например, все собранные логи за 19 августа 2021 года можно найти в директории `/logs/2021-08-19/`.

Название лог файла совпадает с кодом логгера, передоваемым в конструктор класса `Logger`

## Уровни логгирования

В модуле реализованы следующие уровни логирования:

- DEBUG
- INFO
- NOTICE
- WARNING
- ERROR
- CRITICAL
- ALERT
- EMERGENCY

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

## Формат логов

![screen.svg](https://raw.githubusercontent.com/intensa/intensa.logger/master/images/screen.svg)

1. Дата и время записи лога
2. Уровень логирования
3. Место вызова метода логирования
4. Информационное сообщение
5. Контекст логирования

## Примеры использования

### Базовый пример инициализации логгера и демонстрация базовых методов

```php
// подключение модуля
\Bitrix\Main\Loader::includeModule('intensa.logger');

// инициализация объекта логгера.
// в конструктор передаем код логгера, ему будет соответствовать имя лог-файла
$logger = new \Intensa\Logger\Logger('logger_code');

// пример записи логов уровня INFO
$context = ['яблоко', 'мандарин', 'банан'];

$logger->info('сообщение', $context);
$logger->info('сообщение2', $context);

// пример записи логов уровня error
$logger->error('что-то пошло не так', $context);

// пример записи логов уровня emergency
$logger->emergency('алярм! мы все сломали', $context);
```

Содержимое лог файла:

```php
[2024-12-08 16:29:06] info: сообщение array (
  0 => 'яблоко',
  1 => 'мандарин',
  2 => 'банан',
)
[2024-12-08 16:29:06] info: сообщение2 array (
  0 => 'яблоко',
  1 => 'мандарин',
  2 => 'банан',
)
[2024-12-08 16:29:06] error: что-то пошло не так array (
  0 => 'яблоко',
  1 => 'мандарин',
  2 => 'банан',
)
[2024-12-08 16:29:06] emergency: алярм! мы все сломали array (
  0 => 'яблоко',
  1 => 'мандарин',
  2 => 'банан',
)
```

### Пример вызова таймера

```php
// подключение модуля
\Bitrix\Main\Loader::includeModule('intensa.logger');

// инициализация объекта логгера.
// в конструктор передаем код логгера, ему будет соответствовать имя лог-файла
$logger = new \Intensa\Logger\Logger('logger_timer');

$context = ['яблоко', 'мандарин', 'банан'];
$logger->info('Логируем какие-то данные', $context);

// запуск таймера. необходимо передать код таймера
$logger->startTimer('timer_1');
sleep(1);
// остановка таймера. необходимо передать код таймера.
$logger->stopTimer('timer_1');

$logger->startTimer('timer_2');

// можно запускать один таймер внутри другого
$logger->startTimer('timer_internal');
sleep(2);
$logger->stopTimer('timer_internal');

sleep(3);
$logger->stopTimer('timer_2');

// если у таймера не указана точка остановки, то время остановки определяется в дeструкторе класса
$logger->startTimer('dont_stop');
```

Содержимое лог файла:

```
[2024-12-08 16:29:54] info: Логируем какие-то данные array (
  0 => 'яблоко',
  1 => 'мандарин',
  2 => 'банан',
)
[2024-12-08 16:29:55] info: Timer timer_1 array (
  'CODE' => 'timer_1',
  'START_TIME' => '2024-12-08 16:29:54.000000',
  'STOP_TIME' => '2024-12-08 16:29:55.000000',
  'EXEC_TIME' => '1.000298977',
)
[2024-12-08 16:29:57] info: Timer timer_internal array (
  'CODE' => 'timer_internal',
  'START_TIME' => '2024-12-08 16:29:55.000000',
  'STOP_TIME' => '2024-12-08 16:29:57.000000',
  'EXEC_TIME' => '2.000486851',
)
[2024-12-08 16:30:00] info: Timer timer_2 array (
  'CODE' => 'timer_2',
  'START_TIME' => '2024-12-08 16:29:55.000000',
  'STOP_TIME' => '2024-12-08 16:30:00.000000',
  'EXEC_TIME' => '4.999183178',
)
[2024-12-08 16:30:00] info: Timer dont_stop array (
  'CODE' => 'dont_stop',
  'START_TIME' => '2024-12-08 16:30:00.000000',
  'STOP_TIME' => '2024-12-08 16:30:00.000000',
  'EXEC_TIME' => '0.019332170',
  'STOP_POINT' => '__destruct',
)

```

Формат логов таймера:

- CODE - код таймера, задает разработчиком при вызове таймера
- START_TIME - время запуска
- STOP_TIME - время остановки
- EXEC_POINT - время исполнения (разница между временем остановки и временем запуска)
- START_POINT - место определения точки запуска (вызов метода startTimer())
- STOP_POINT - место определения точки остановки (вызов метода stopTimer()). Значение "__destruct" означает о том, что не был вызван метод stopTimer() для текущего счетчика и остановка произошла в деструкторе класса.

### Использование трекера запросов

```php
\Bitrix\Main\Loader::includeModule('intensa.logger');

$logger = new \Intensa\Logger\Logger('logger_sql');
// запускаем трекер sql запросов
$logger->startSqlTracker('get_users');
// пример кода, который делает запрос к базе данных
$users = [];
$result = \Bitrix\Main\UserTable::getList([
    'select' => ['ID','SHORT_NAME'],
    'order' => ['LAST_LOGIN'=>'DESC'],
    'limit' => 3
]);
// остановка трекера
$logger->stopSqlTracker('get_users');
```

Содержимое лог файла:

```
[2024-12-08 16:31:11] info: SqlTracker get_users: array (
  0 => 
  array (
    'query' => 'SELECT 
	`main_user`.`ID` AS `ID`,
	CONCAT(`main_user`.`LAST_NAME`, \' \', UPPER(SUBSTR(`main_user`.`NAME`, 1, 1)), \'.\') AS `SHORT_NAME`
FROM `b_user` `main_user`

ORDER BY `main_user`.`LAST_LOGIN` DESC
LIMIT 0, 3
',
    'time' => 0.000804901123046875,
  ),
)
```

## Доступные методы логгера

Ниже описаны доступные методы класса `Logger` , которые помогут костомизировать поведение каждого отдельного объекта логгера.

```php
\Bitrix\Main\Loader::includeModule('intensa.logger');

$logger = new \Intensa\Logger\Logger('logger_sql');

// Метод заставляет логгер перезаписывать файл при каждом новом вызове логирующего метода
// Данная фича может приходиться при дебаге
$logger->rewrite();

// Позволяет отключить отладку для конкретного логгера.
// Рекомендуется использовать данную настройку для логгеров записывающих большое кол-во данных при одном вызове
// Снижает количество оперативной памяти выделяемой php
$logger->notUseBacktrace();

// Включает отладку для конкретного логгера.
// Используется в случае когда глобально в настройках модуля выключена настройка отладки
$logger->useBacktrace();
```

## Запуск тестов

Для запуска юнит тестов необходимо:

- Перейти в директорию `/lib/`
- Установить зависимости. Выполнить `composer install`
- Выполнить `./vendor/bin/phpunit tests`

## Автор

Шишкин Иван - i.shishkin@intensa.ru - [telegram @ishishkin](https://t.me/ishishkin)

intensa.logger

intensa.logger Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

intensa.logger

intensa.logger Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README