seablast/logger

A PSR-3 compliant logger with adjustable verbosity.

v2.0.1 2024-08-09 22:39 UTC

Requires

• php: ^7.1 || ^8.0
• psr/log: ^1.0 || ^2.0 || ^3.0
• tracy/tracy: ^2.6.0

Requires (Dev)

• phpunit/phpunit: ^6 || ^7 || ^8 || ^9 || ^10 || ^11

MIT

• Stanislav Rejthar

README

A PSR-3 compliant logger with adjustable verbosity.

The logging level verbosity can be tailored to suit different environments. For instance, in a development environment, the logger can be configured to log more detailed information compared to a production environment, all without changing your code. Simply adjust the verbosity.

The logging_level is the most important setting. These parameters can be configured when instantiating the logger:

use Seablast\Logger\Logger;
$conf = array(
    // THESE ARE THE DEFAULT SETTINGS
    // 0 = send message to PHP's system logger; recommended is however 3, i.e. append to the file destination set in the field 'logging_file'
    Logger::CONF_ERROR_LOG_MESSAGE_TYPE => 0,
    // if error_log_message_type equals 3, the message is appended to this file destination (path and name)
    Logger::CONF_LOGGING_FILE => '',
    // verbosity: log up to the level set here, default=5 = debug
    Logger::CONF_LOGGING_LEVEL => 5,
    // rename or renumber, if needed
    Logger::CONF_LOGGING_LEVEL_NAME => array(0 => 'unknown', 1 => 'fatal', 'error', 'warning', 'info', 'debug', 'speed'),
    // the logging level to which the page generation speed (i.e. error_number 6) is to be logged
    Logger::CONF_LOGGING_LEVEL_PAGE_SPEED => 5,
    // false => use logging_file with log extension as destination; true => adds .Y-m.log to the logging file
    Logger::CONF_LOG_MONTHLY_ROTATION => true,
    // prefix message that took longer than profiling step (float) sec from the previous one by SLOWSTEP
    Logger::CONF_LOG_PROFILING_STEP => false,
    // fatal error may just be written in log, on production, it is however recommended to set an e-mail, where to announce fatal errors
    Logger::CONF_MAIL_FOR_ADMIN_ENABLED => false,
);
$logger = new Logger($conf);

See test.php for usage.

By default the logger logs the following levels of information:

• fatal
• error
• warning
• info
• debug

And ignores

• speed

Note: Outputting log messages to the screen is not supported.

Runtime adjustment

• method logAtLeastToLevel(int $level) may change the verbosity level above the level set when instatiating.
• method setUser(int|string $user) may add the user identification to the error messages

Tracy\Logger::log wrapper

Since Nette\Tracy::v2.6.0, i.e. "php": ">=7.1" it is possible to use a PSR-3 adapter, allowing for integration of seablast/logger.

$logger = new \Seablast\Logger\Logger();
$tracyLogger = new \Tracy\Bridges\Psr\PsrToTracyLoggerAdapter($logger);
Debugger::setLogger($tracyLogger);
Debugger::enable();