kronos/log

PSR-3 compliant logging component

v3.5.1 2022-06-21 19:42 UTC

Requires

• php: ^7.4 || ^8.1
• php-http/guzzle6-adapter: ^2.0
• psr/log: ^1.0

Requires (Dev)

• cyclonedx/cyclonedx-php-composer: 3.10.0
• dealerdirect/phpcodesniffer-composer-installer: 0.7.2
• fluent/logger: 1.0.1
• graylog2/gelf-php: 1.7.1
• guzzlehttp/guzzle: 6.5.8
• phpcompatibility/php-compatibility: 9.3.5
• phpunit/phpunit: 9.5.21
• sentry/sentry: 3.6.0
• vimeo/psalm: 4.23.0

Suggests

• fluent/logger: Required for Fluentd writer
• graylog2/gelf-php: Required for Graylog writer
• guzzlehttp/guzzle: Required for LogDNA writer
• sentry/sentry: Required for Sentry writer

MIT

• log
• logging
• psr
• kronos

README

PSR-3 Compliant implementation.

See php-fig/log for more information on root classes and interfaces.

Usage

use Kronos\Log;

$logger = new Log\Logger();

$debug = new Log\Writer\File('/var/log/debug.log', new Kronos\Log\Adaptor\FileFactory());
$logger->addWriter($debug);

...

$logger->info('Need more {drink}', ['drink' => 'coffee']);

This is a simple usage of a logger with a writer which output into given files.

It's possible to use multiple writer accepting only some log levels.

use Kronos\Log;

$logger = new Log\Logger();
$logger->addContext('user', $current_user);

$debug = new Log\Writer\File('/var/log/debug.log');
$debug->setMaxLevel(\Psr\Log\LogLevel::WARNING);
$logger->addWriter($debug);

$syslog = new Log\Writer\Syslog('application-name');
$syslog->setMinLevel(\Psr\Log\LogLevel::ERROR);
$logger->addWriter($syslog);

...

try {
    $logger->debug('Trying something with {value}', ['value' => $some_variable]);
    
    // Something
}
catch(\Exception $e) {
    $logger->error('Something did not work', ['exception' => $e]);
}

Here the info will be writen in /var/log/debug.log while the error will be sent to syslog.

Using the builder

You can use the builder to quickly create a fully configured logger.

$settings = [
	[
		'type' => \Kronos\Log\Enumeration\WriterTypes::FILE,
		'settings' => [
			'filename' => '/var/log/debug.log'
		]
	],
	[
		'type' => \Kronos\Log\Enumeration\WriterTypes::SENTRY,
		'settings' => [
			'minLevel' => \Psr\Log\LogLevel::ERROR,
			'key' => 'kronos',
			'secret' => 'supersecrethash',
			'projectId' => 12345
		]
	],
	[
		'type' => \Kronos\Log\Enumeration\WriterTypes::LOGDNA,
		'settings' => [
			'minLevel' => \Psr\Log\LogLevel::INFO,
			'hostname' => gethostname(),
			'application' => 'app-name',
			'ingestionKey' => 'anothersecrethash'
		]
	]
];

$builder = new \Kronos\Log\Builder();
$logger = $builder->buildFromArray($settings);