andrey-tech / debug-logger-php
Простой логгер на PHP7+, сохраняющий отладочную информацию в файл вместе с данными об объеме используемой оперативной памяти и прошедшем времени
Installs: 48 106
Dependents: 3
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 3
Open Issues: 0
Requires
- php: >=7.0
- ext-json: *
README
Простой логгер на PHP7+, сохраняющий отладочную информацию в файл вместе с данными об объеме используемой оперативной памяти и прошедшем времени.
Содержание
Требования
- PHP >= 7.0;
- Произвольный автозагрузчик классов, реализующий стандарт PSR-4.
Установка
Установка через composer:
$ composer require andrey-tech/debug-logger-php:"^2.0"
или добавить
"andrey-tech/debug-logger-php": "^2.0"
в секцию require файла composer.json.
Класс DebugLogger
Класс \App\DebugLogger\DebugLogger
обеспечивает логирование отладочной информации в файл.
При возникновении ошибок выбрасывается исключение класса \App\DebugLogger\DebugLoggerException
.
Методы класса
static instance(string $logFileName = 'debug.log'): DebugLogger
Возвращает единственный объект классаDebugLogger
для заданного лог-файла$logFileName
.$logFileName
- имя лог-файла.
save(mixed $info, object $object = null, string $header = null): void
Сохраняет подлежащую логированию информацию в файл.$info
- строка, массив или объект для логирования;$object
- ссылка на объект класса в котором выполняется логирование;$header
- строка заголовка для сохраняемой в лог файл информации.
Дополнительные параметры
Дополнительные параметры устанавливаются через публичные свойства класса \App\DebugLogger\DebugLogger
:
Примеры
use App\DebugLogger\DebugLogger; use App\DebugLogger\DebugLoggerException; try { // Устанавливаем каталог для сохранения лог-файлов DebugLogger::$logFileDir = 'logs/'; $logFileName = 'debug_extensions.log'; $logger = DebugLogger::instance($logFileName); // Включаем логирование $logger->isActive = true; // Сохраняем информацию о всех скомпилированных и загруженных модулях PHP $logger->save(get_loaded_extensions(), null, 'PHP modules'); // Сохраняем версию движка Zend PHP $logger->save(zend_version(), null, 'Zend engine'); } catch (DebugLoggerException $e) { printf('Ошибка (%d): %s' . PHP_EOL, $e->getCode(), $e->getMessage()); }
Пример результатов логирования
*** ytoqjz5 [2020-06-14 12:57:18.420258 +00:00 Δ- s, 0.69/2.00 MiB] ********************
PHP modules
[
"Core",
"bcmath",
"calendar",
"ctype"
]
*** ytoqjz5 [2020-06-14 12:57:18.421359 +00:00 Δ0.001101 s, 0.69/2.00 MiB] ********************
Zend engine
3.2.0
Формат логирования
*** ytoqjz5 [2020-06-14 12:57:18,421359 +00:00 Δ0.001101 s, 0.69/2.00 MiB] ********************
Zend engine
3.2.0
ytoqjz5
- уникальный буквенно-цифровой [a-z0-9]+ идентификатор объекта классаDebugLogger
, позволяющий находить в лог файле записи, созданные одним и тем же процессом;2020-06-14 12:57:18.421359 +00:00
- дата и время сохранения информации с точностью до микросекунд;Δ0.001101 s
- время, прошедшее с момента предыдущего сохранения информации в секундах и микросекундах;0.69/2.00 MiB
- данные об используемой оперативной памяти в единицах количества информации с двоичными приставками:0.69
- максимальный объем памяти, который был выделен PHP-скрипту системой;2.00
- реальный объем памяти, выделенный PHP-скрипту системой;
- 'Zend engine' - заголовок для сохраняемой информации, задаваемый параметром
$header
методаsave()
; - '3.2.0' - сохраняемая информация, задаваемая параметром
$info
методаsave()
.
Автор
© 2019-2022 andrey-tech
Лицензия
Данная библиотека распространяется на условиях лицензии MIT.