axleus/axleus-log

Axleus Logging component

dev-master 2025-04-01 02:28 UTC

Requires

• php: ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0
• axleus/axleus-db: dev-master
• laminas/laminas-component-installer: ^3.2
• laminas/laminas-hydrator: ^4.15.0
• monolog/monolog: ^3.4
• ramsey/uuid: ^4.7

Requires (Dev)

• laminas/laminas-coding-standard: ^3.0
• phpunit/phpunit: ^11.0
• psalm/plugin-phpunit: ^0.19.0
• roave/security-advisories: dev-master
• vimeo/psalm: ^6.0

BSD-3-Clause

• Joey Smith

• monolog
• psr 3
• axleus

README

This package provides logging via Monolog for all laminas-mvc and mezzio applications. It provides a log handler backed by laminas-db for writing logs to a database table. It also provides event listeners for error logging in both frameworks.

Mezzio Integration

Just pipe the middleware into your application as early as required to provide logging for all future middleware/handlers. If you are using the default Mezzio pipeline, this should be done in the config/pipeline.php file. If you are delegating your pipeline to configuration you can uncomment the following in the ConfigProvider class.

'middleware_pipeline' => $this->getPipelineConfig(),

To enable error logging in Mezzio or MVC simply provide the following top level config key from any ConfigProvider or config file.

return [
    \Axleus\Log\ConfigProvider::class => [
        'log_errors' => true,
    ],
];

Default Channels

By default, the following channels are provided for logging:

• app
• error
• user

To provide some safety around channels the module provides Axleus\Log\LogChannel which is a BackedEnum.

Finally, you can import the file ./test/integration/TestFixtures/mysql.sql into your database to create the required table for logging. If you are not using mysql, then you can use it as a guide to create the table in your database of choice as long as its supported by laminas-db.

Everything else should just work out of the box.