README

Installation

You can install this plugin into your CakePHP application using composer.

The recommended way to install composer packages is:

composer require passchn/cakephp-logging

Load the plugin:

bin/cake plugin load Passchn/CakeLogging

Usage

The plugin enables you to configure the Cake Log class to use implementations of the PSR-3 logger interface which are available in your Applications container.

It comes with a MultiLogger where you can define multiple implementations as fallbacks.

Configuration

In your config/app.php you can configure the logger like this:

return [
    'Log' => [
        'debug' => [
            'className' => LoggerFacade::class, // use the facade to configure the actual logger
            LoggerFacade::CONFIG_KEY_UNDERLYING_LOGGER => MyLoggerImplementation::class, // a LoggerInterface implementation
        ],
    ],
];

Note that MyLoggerImplementation must be available in your container.

MultiLogger usage

You can also use the MultiLogger to define multiple fallbacks:

return [
    
    // default config for the multi logger
    MultiLoggerConfig::class => [
        MultiLoggerConfig::CONFIG_KEY_LOGGERS => [
            SentryLogger::class,
            FileLog::class,
        ],
    ],
    
    'Log' => [
        'debug' => [
            'className' => LoggerFacade::class,
            LoggerFacade::CONFIG_KEY_UNDERLYING_LOGGER => MultiLogger::class,
            MultiLoggerConfig::class => [
                // multi logger config can be overridden here
                MultiLoggerConfig::CONFIG_KEY_LOGGERS => [
                    MyLoggerImplementation::class,
                    AnotherLoggerImplementation::class,
                    FileLog::class, // the default file logger as fallback
                ],
            ],
            'path' => LOGS,
            'file' => 'debug',
            'url' => env('LOG_DEBUG_URL', null),
            'scopes' => null,
            'levels' => ['notice', 'info', 'debug'],
        ],
        
        'error' => [
            // ...
        ],
        
        'emergency' => [
            'className' => FileLog::class,
            'className' => LoggerFacade::class,
            LoggerFacade::CONFIG_KEY_UNDERLYING_LOGGER => MultiLogger::class,
            MultiLoggerConfig::CONFIG_KEY_LOGGERS => [
                SmsEmergencyLogger::class,
                AlexaTextToSpeechAlarmWithWaterSprinklerLogger::class,
            ],
        ],
    ],
];

If you use the default FileLogger, leave the config keys as they are as they will be used for the FileLog configuration.

Every logger used by the multi logger must be an implementation of the LoggerInterface which is available in your container.

Configuring custom loggers

If you want to configure a custom logger, you can do so by implementing the LoggerInterface and adding it to your container.

use Psr\Log\LoggerInterface;

class MyLoggerImplementation extends \Psr\Log\AbstractLogger implements LoggerInterface
{
    public function __construct(
        private readonly SomeDependency $dependency,
    ) {
        // ...
    }

    public function log($level, $message, array $context = [])
    {
        // your implementation
    }
}

Then, you can add it to your container.

In your Application.php:

public function services(ContainerInterface $container): void
{
    $container->add(
        MyLoggerImplementation::class, 
        fn () => new MyLoggerImplementation(
            $container->get(SomeDependency::class),
        ),
    );
}

Then, you can just use the implementation by adding the class name in your app.php configuration for the respective logging scope:

MultiLoggerConfig::CONFIG_KEY_LOGGERS => [
    MyLoggerImplementation::class,
    ...
],

Learn more about Dependency Injection in the CakePHP Book.

Collaboration

If you have any ideas or encounter a bug, feel free to open an issue or a pull request.

passchn / cakephp-logging

Maintainers

Details