The Web and GRPC bundles include default integration with https://github.com/Seldaek/monolog to manage logs.
The extension can be configured using a configuration file or a bootloader.
The configuration file for this extension should be located in app/config/monolog.php. In this file, you can
configure the default Monolog handler, global logging level, handlers and processors.
For example, the configuration file might look like this:
<?php
return [
/**
* -------------------------------------------------------------------------
* Default Monolog handler
* -------------------------------------------------------------------------
*/
'default' => env('MONOLOG_DEFAULT_CHANNEL', 'default'),
/**
* -------------------------------------------------------------------------
* Global logging level
* -------------------------------------------------------------------------
*
* Monolog supports the logging levels described by RFC 5424.
*
* @see https://github.com/Seldaek/monolog/blob/main/doc/01-usage.md#log-levels
*/
'globalLevel' => \Monolog\Logger::toMonologLevel(env('MONOLOG_DEFAULT_LEVEL', \Monolog\Logger::DEBUG)),
/**
* -------------------------------------------------------------------------
* Handlers
* -------------------------------------------------------------------------
*
* @see https://github.com/Seldaek/monolog/blob/main/doc/02-handlers-formatters-processors.md#handlers
*/
'handlers' => [
'default' => [
[
'class' => 'log.rotate',
'options' => [
'filename' => directory('runtime') . 'logs/app.log',
'level' => \Monolog\Logger::DEBUG,
],
],
],
'stderr' => [
\Monolog\Handler\ErrorLogHandler::class,
],
'stdout' => [
[
'class' => \Monolog\Handler\SyslogHandler::class,
'options' => [
'ident' => 'app',
'facility' => LOG_USER,
],
],
],
],
/**
* -------------------------------------------------------------------------
* Processors
* -------------------------------------------------------------------------
*
* Processors allows adding extra data for all records.
*
* @see https://github.com/Seldaek/monolog/blob/main/doc/02-handlers-formatters-processors.md#processors
*/
'processors' => [
'default' => [
// ...
],
'stdout' => [
[
'class' => \Monolog\Processor\PsrLogMessageProcessor::class,
'options' => [
'dateFormat' => 'Y-m-d\TH:i:s.uP',
],
],
],
],
];
Use Spiral\Monolog\Bootloader\MonologBootloader to declare a handler and a log-formatter for a specific channel:
namespace App\Bootloader;
use Spiral\Boot\Bootloader\Bootloader;
use Spiral\Monolog\Bootloader\MonologBootloader;
class LoggingBootloader extends Bootloader
{
protected const DEPENDENCIES = [
MonologBootloader::class
];
public function boot(MonologBootloader $monolog): void
{
$monolog->addHandler(
'my-channel',
$monolog->logRotate(directory('runtime') . 'logs/my-channel.log')
);
}
}
Note
You can use any monolog handler as the second argument. Make sure to add your Bootloader at the top of the LOAD list.
You receive the default logger using the Psr\Log\LoggerInterface dependency:
use Psr\Log\LoggerInterface;
// ...
public function index(LoggerInterface $logger): void
{
$logger->alert('message');
}
To get a logger for a specific channel, use Spiral\Logger\LogsInterface:
use Spiral\Logger\LogsInterface;
// ...
public function index(LogsInterface $logs): void
{
$logs->getLogger('my-channel')->alert('message');
}
Make sure to enable the default handler for saving content to the file:
namespace App\Bootloader;
use Spiral\Boot\Bootloader\Bootloader;
use Spiral\Monolog\Bootloader\MonologBootloader;
class LoggingBootloader extends Bootloader
{
protected const DEPENDENCIES = [
MonologBootloader::class
];
public function boot(MonologBootloader $monolog): void
{
$monolog->addHandler(
'default',
$monolog->logRotate(directory('runtime') . 'logs/debug.log')
);
}
}
You can use Spiral\Logger\Traits\LoggerTrait to quickly assign a Logger to any class. The class name will be used as the
channel name:
use Spiral\Logger\Traits\LoggerTrait;
class HomeController
{
use LoggerTrait;
public function index(): void
{
$this->getLogger()->alert('message');
}
}
And assign a logger to it:
public function boot(MonologBootloader $monolog): void
{
$monolog->addHandler(
HomeController::class,
$monolog->logRotate(directory('runtime') . 'logs/home-controller.log') // handler
);
}
Note
LoggerTrait only works inside the$app->serve()method via the global IoC scope.
To aggregate all application errors into a single log file, subscribe to the default channel:
namespace App\Bootloader;
use Monolog\Logger;
use Spiral\Boot\Bootloader\Bootloader;
use Spiral\Monolog\Bootloader\MonologBootloader;
class LoggingBootloader extends Bootloader
{
protected const DEPENDENCIES = [
MonologBootloader::class
];
public function boot(MonologBootloader $monolog): void
{
$monolog->addHandler(
'default',
$monolog->logRotate(directory('runtime') . 'logs/errors.log', Logger::ERROR) // only ERROR and above
);
}
}
Use the second argument of the dump function to dump directly into the default log channel:
dump('hello', \Spiral\Debug\Dumper::LOGGER);