monolog

Monolog – Logging for PHP

Note This is the documentation for Monolog 3.x, if you are using older releases
see the documentation for Monolog 2.x or Monolog 1.x

Monolog sends your logs to files, sockets, inboxes, databases and various
web services. See the complete list of handlers below. Special handlers
allow you to build advanced logging strategies.

This library implements the PSR-3
interface that you can type-hint against in your own libraries to keep
a maximum of interoperability. You can also use it in your applications to
make sure you can always use another compatible logger at a later time.
As of 1.11.0 Monolog public APIs will also accept PSR-3 log levels.
Internally Monolog still uses its own level scheme since it predates PSR-3.

^{Sponsored by:}

Better Stack lets you centralize, search, and visualize your logs.

Installation

Install the latest version with

composer require monolog/monolog

Basic Usage

<?php

use Monolog\\Level;
use Monolog\\Logger;
use Monolog\\Handler\\StreamHandler;

// create a log channel
$log = new Logger(\'name\');
$log->pushHandler(new StreamHandler(\'path/to/your.log\', Level::Warning));

// add records to the log
$log->warning(\'Foo\');
$log->error(\'Bar\');

Documentation

• Usage Instructions
• Handlers, Formatters and Processors
• Utility Classes
• Extending Monolog
• Log Record Structure

Support Monolog Financially

Get supported Monolog and help fund the project with the Tidelift Subscription or via GitHub sponsorship.

Tidelift delivers commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use.

Third Party Packages

Third party handlers, formatters and processors are
listed in the wiki. You
can also add your own there if you publish one.

About

Requirements

• Monolog ^3.0 works with PHP 8.1 or above.
• Monolog ^2.5 works with PHP 7.2 or above.
• Monolog ^1.25 works with PHP 5.3 up to 8.1, but is not very maintained anymore and will not receive PHP support fixes anymore.

Support

Monolog 1.x support is somewhat limited at this point and only important fixes will be done. You should migrate to Monolog 2 or 3 where possible to benefit from all the latest features and fixes.

Submitting bugs and feature requests

Bugs and feature request are tracked on GitHub

Framework Integrations

• Frameworks and libraries using PSR-3
  can be used very easily with Monolog since it implements the interface.
• Symfony comes out of the box with Monolog.
• Laravel comes out of the box with Monolog.
• Lumen comes out of the box with Monolog.
• PPI comes out of the box with Monolog.
• CakePHP is usable with Monolog via the cakephp-monolog plugin.
• XOOPS 2.6 comes out of the box with Monolog.
• Aura.Web_Project comes out of the box with Monolog.
• Nette Framework is usable with Monolog via the contributte/monolog or orisai/nette-monolog extensions.
• Proton Micro Framework comes out of the box with Monolog.
• FuelPHP comes out of the box with Monolog.
• Equip Framework comes out of the box with Monolog.
• Yii 2 is usable with Monolog via the yii2-monolog or yii2-psr-log-target plugins.
• Hawkbit Micro Framework comes out of the box with Monolog.
• SilverStripe 4 comes out of the box with Monolog.
• Drupal is usable with Monolog via the monolog module.
• Aimeos ecommerce framework is usable with Monolog via the ai-monolog extension.
• Magento comes out of the box with Monolog.
• Spiral Framework comes out of the box with Monolog bridge.

Author

Jordi Boggiano – j.boggiano@seld.be – http://*t*witt*er.com/seldaek
See also the list of contributors who participated in this project.

License

Monolog is licensed under the MIT License – see the LICENSE file for details

Acknowledgements

This library is heavily inspired by Python\’s Logbook
library, although most concepts have been adjusted to fit to the PHP world.