mimmi20 / monolog-factory
Provides a Factory to build a Monolog Logger.
Installs: 51 130
Dependents: 1
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 1
Requires
- php: ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0
- ext-mbstring: *
- monolog/monolog: ^3.7.0
- psr/container: ^1.1.2 || ^2.0.2
- psr/log: ^3.0.0
Requires (Dev)
- ext-ctype: *
- ext-dom: *
- ext-simplexml: *
- ext-tokenizer: *
- ext-xml: *
- ext-xmlwriter: *
- actived/microsoft-teams-notifier: ^1.3.0
- aws/aws-sdk-php: ^3.321.11
- doctrine/couchdb: 1.0.0-beta4
- elasticsearch/elasticsearch: ^7.17.2 || ^8.7.0
- ezimuel/ringphp: ^1.2.2
- graylog2/gelf-php: ^2.0.1
- guzzlehttp/guzzle: ^7.9.2
- guzzlehttp/psr7: ^2.7.0
- infection/infection: ^0.27.11 || ^0.28.1
- jk/monolog-request-header-processor: ^1.0.0
- laminas/laminas-config: ^3.9.0
- laminas/laminas-eventmanager: ^3.13.1
- laminas/laminas-modulemanager: ^2.16.0
- laminas/laminas-servicemanager: ^3.22.1 || ^4.0.0
- mikey179/vfsstream: ^1.6.12
- mimmi20/coding-standard: ^5.2.43
- mimmi20/monolog-callbackfilterhandler: ^3.0.7
- mimmi20/monolog-streamformatter: ^3.1.4
- nikic/php-parser: ^4.19.1 || ^5.0.2
- php-console/php-console: ^3.1.8
- phpstan/extension-installer: ^1.4.3
- phpstan/phpstan: ^1.12.3
- phpstan/phpstan-deprecation-rules: ^1.2.1
- phpstan/phpstan-phpunit: ^1.4.0
- phpunit/phpunit: ^10.5.25
- predis/predis: ^1.1.10 || ^2.1.2
- rector/rector: ^1.2.5
- rector/type-perfect: ^0.2.0
- ruflin/elastica: ^8.0.0
- symfony/mailer: ^6.4.9
- symfony/mime: ^6.4.9
- symplify/phpstan-rules: ^13.0.1
- tomasvotruba/cognitive-complexity: ^0.2.3
- tomasvotruba/type-coverage: ^0.3.1
- tomasvotruba/unused-public: ^0.3.11
Suggests
- ext-amqp: Allow sending log messages to an AMQP server (1.0+ required)
- ext-curl: Allow sending log messages to some handlers
- ext-json: Allow sending log messages to the ChromePHP Handler
- ext-mongodb: Allow sending log messages to a MongoDB server (via driver)
- ext-openssl: Allow sending log messages to some handlers
- ext-sockets: Allow sending log messages to a Syslog server (via UDP driver)
- actived/microsoft-teams-notifier: Allow sending log messages to Microsoft Teams
- aws/aws-sdk-php: Allow sending log messages to AWS services like DynamoDB
- bartlett/monolog-callbackfilterhandler: Allow filtering log messages based on a callback function
- cmdisp/monolog-microsoft-teams: Allow sending log messages to Microsoft Teams
- doctrine/couchdb: Allow sending log messages to a CouchDB server
- elasticsearch/elasticsearch: Allow sending log messages to an Elasticsearch server via official client
- graylog2/gelf-php: Allow sending log messages to a GrayLog2 server
- jk/monolog-request-header-processor: Allow to add request headers to the log message
- laminas/laminas-modulemanager: Required for the module configuration
- laminas/laminas-servicemanager: Required for the Factories
- mongodb/mongodb: Allow sending log messages to a MongoDB server (via library)
- php-amqplib/php-amqplib: Allow sending log messages to an AMQP server using php-amqplib
- rollbar/rollbar: Allow sending log messages to Rollbar
- ruflin/elastica: Allow sending log messages to an Elastic Search server
This package is auto-updated.
Last update: 2024-11-02 11:43:36 UTC
README
Monolog Factories for Laminas and Mezzio
This library was inspired by psr11-monolog and monolog-factory.
Code Status
Table of Contents
- Installation
- Usage with Laminas and Mezzio
- Configuration
Installation
Run
composer require mimmi20/monolog-factory
Usage with Laminas and Mezzio
You'll need to add configuration and register the services you'd like to use. There are number of ways to do that
but the recommended way is to create a new config file config/autoload/logger.config.php
Configuration
config/autoload/logger.config.php
<?php return [ 'log' => [ 'default' => [ 'name' => 'name', 'errorLevelMap' => false, // optional: map of php errors to monolog levels, use an empty array if the default map should be used, defaults to false which disables the error handling 'exceptionLevelMap' => false, // optional: map of exceptions to monolog levels, use an empty array if the default map should be used, defaults to false which disables the exception handling 'fatalLevel' => false, // optional: monolog level used to log fatal errors, use null if the default level should be used, defaults to false which disables the handling of fatal errors 'handlers' => [ // Handlers for Monolog // At the bare minimum you must include a default handler config. // Otherwise log entries will be sent to the void. 'default' => [ 'type' => 'stream', 'enabled' => true, 'options' => [ 'stream' => '/var/log/some-log-file.txt', ], ], // Another Handler 'myOtherHandler' => [ 'type' => 'stream', 'enabled' => false, 'options' => [ 'stream' => '/var/log/someother-log-file.txt', ], ], ], 'processors' => [], ], ], ];
Minimal Configuration
A minimal configuration would consist of at least one default handler and one named service. Please note that if you don't specify a default handler a NullHandler will be used when you wire up the default logger.
Minimal Example (using Mezzio for the example)
<?php return [ 'log' => [ 'default' => [ 'name' => 'name', 'handlers' => [ 'default' => [ 'type' => 'stream', 'options' => [ 'stream' => '/var/log/some-log-file.txt', ], ], ], ], ], ];
Full Configuration
Full Example
<?php return [ 'log' => [ 'default' => [ 'name' => 'name', 'handlers' => [ 'default' => [ // A Handler type or pre-configured service from the container 'type' => 'stream', // Handler specific options. See handlers below 'options' => [ 'stream' => '/tmp/log_one.txt', // Optional: Formatter for the handler. 'formatter' => [ 'type' => 'line', // formatter specific options. See formatters below 'options' => [], ], // Optional: Processor for the handler 'processors' => [ [ // A processor type or pre-configured service from the container 'type' => 'psrLogMessage', // processor specific options. See processors below 'options' => [], ], ], ], ], ], 'processors' => [ // Array Keys are the names used for the processors 'processorOne' => [ // A processor type or pre-configured service from the container 'type' => 'psrLogMessage', // processor specific options. See processors below 'options' => [], ], ], ], ], ];
Handlers
Log to files and syslog
StreamHandler
Logs records into any PHP stream, use this for log files.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'stream', 'options' => [ 'stream' => '/tmp/stream_test.txt', // Required: File Path | Resource | Service Name 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'filePermission' => null, // Optional: file permissions (default (0644) are only for owner read/write) 'useLocking' => false, // Optional: Try to lock log file before doing any writes 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: StreamHandler
RotatingFileHandler
Logs records to a file and creates one logfile per day. It will also delete files older than $maxFiles. You should use [logrotate] for high profile setups though, this is just meant as a quick and dirty solution.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'rotating', 'options' => [ 'filename' => '/tmp/stream_test.txt', // Required: File Path 'maxFiles' => 0, // Optional: The maximal amount of files to keep (0 means unlimited) 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'filePermission' => null, // Optional: file permissions (default (0644) are only for owner read/write) 'useLocking' => false, // Optional: Try to lock log file before doing any writes 'filenameFormat' => '{filename}-{date}', // Optional 'dateFormat' => 'Y-m-d', // Optional 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: RotatingFileHandler
SyslogHandler
Logs records to the syslog.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'syslog', 'options' => [ 'ident' => '/tmp/stream_test.txt', // Required: The string ident is added to each message. 'facility' => LOG_USER, // Optional: The facility argument is used to specify what type of program is logging the message. 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'logOpts' => LOG_PID, // Optional: Option flags for the openlog() call, defaults to LOG_PID 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: SyslogHandler PHP openlog(): openlog
ErrorLogHandler
Logs records to PHP's error_log() function.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'errorlog', 'options' => [ 'messageType' => \Monolog\Handler\ErrorLogHandler::OPERATING_SYSTEM, // Optional: Says where the error should go. 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'expandNewlines' => false, // Optional: If set to true, newlines in the message will be expanded to be take multiple log entries 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: ErrorLogHandler
ProcessHandler
Logs records to the STDIN of any process, specified by a command.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'process', 'options' => [ 'command' => 'some-command', // Command for the process to start. Absolute paths are recommended, especially if you do not use the $cwd parameter. 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'cwd' => __DIR__, // Optional: "Current working directory" (CWD) for the process to be executed in. 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: ProcessHandler
Send alerts and emails
NativeMailerHandler
Sends emails using PHP's mail() function.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'nativeMailer', 'options' => [ 'to' => ['email1@test.com', 'email2@test.com'], // The receiver of the mail. Can be an array or string 'subject' => 'Error Log', // The subject of the mail 'from' => 'sender@test.com', // The sender of the mail 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'maxColumnWidth' => 80, // Optional: The maximum column width that the message lines will have 'contentType' => 'text/html', // Optional 'encoding' => 'utf-8', // Optional 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: NativeMailerHandler
SymfonyMailerHandler
Sends emails using a symfony/mailer instance.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'symfonyMailer', 'options' => [ 'mailer' => 'my-service', // The mailer to use. Must be a valid service name in the container 'email-template' => 'my-template', // An email template, the subject/body will be replaced 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: SymfonyMailerHandler
PushoverHandler
Sends mobile notifications via the Pushover API. Requires the sockets Extension.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'pushover', 'options' => [ 'token' => 'sometokenhere', // Pushover api token 'users' => ['email1@test.com', 'email2@test.com'], // Pushover user id or array of ids the message will be sent to 'title' => 'Error Log', // Optional: Title sent to the Pushover API 'level' => \Psr\Log\LogLevel::INFO, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => false, // Optional: Whether the messages that are handled can bubble up the stack or not 'useSSL' => false, // Optional: Whether to connect via SSL. Required when pushing messages to users that are not the pushover.net app owner. OpenSSL is required for this option. 'highPriorityLevel' => \Psr\Log\LogLevel::WARNING, // Optional: The minimum logging level at which this handler will start sending "high priority" requests to the Pushover API 'emergencyLevel' => \Psr\Log\LogLevel::ERROR, // Optional: The minimum logging level at which this handler will start sending "emergency" requests to the Pushover API 'retry' => 22, // Optional: The retry parameter specifies how often (in seconds) the Pushover servers will send the same notification to the user. 'expire' => 300, // Optional: The expire parameter specifies how many seconds your notification will continue to be retried for (every retry seconds). 'timeout' => 10.0, // Optional 'writeTimeout' => 5.0, // Optional 'persistent' => false, // Optional 'chunkSize' => 100, // Optional 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: PushoverHandler
FlowdockHandler
Logs records to a Flowdock account. Requires the openssl and sockets Extensions.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'flowdock', 'options' => [ 'apiToken' => 'sometokenhere', // HipChat API Token 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'timeout' => 10.0, // Optional 'writeTimeout' => 5.0, // Optional 'persistent' => false, // Optional 'chunkSize' => 100, // Optional 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: FlowdockHandler
SlackWebhookHandler
Logs records to a Slack account using Slack Webhooks. Requires the curl Excension.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'slackWebhook', 'options' => [ 'webhookUrl' => 'webhook.slack.com', // Slack Webhook URL 'channel' => 'channel', // Slack channel (encoded ID or name) 'userName' => 'log', // Name of a bot 'useAttachment' => false, // Optional: Whether the message should be added to Slack as attachment (plain text otherwise) 'iconEmoji' => null, // Optional: The emoji name to use (or null) 'useShortAttachment' => true, // Optional: Whether the the context/extra messages added to Slack as attachments are in a short style 'includeContextAndExtra' => true, // Optional: Whether the attachment should include context and extra data 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => false, // Optional: Whether the messages that are handled can bubble up the stack or not 'excludeFields' => ['context.field1', 'extra.field2'], // Optional: Dot separated list of fields to exclude from slack message. 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: SlackWebhookHandler
SlackHandler
Logs records to a SlackHandler account using the Slack API (complex setup). Requires the openssl and sockets Extensions.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'slack', 'options' => [ 'token' => 'apiToken', // Slack API token 'channel' => 'channel', // Slack channel (encoded ID or name) 'userName' => 'log', // Name of a bot 'useAttachment' => false, // Optional: Whether the message should be added to Slack as attachment (plain text otherwise) 'iconEmoji' => null, // Optional: The emoji name to use (or null) 'useShortAttachment' => true, // Optional: Whether the the context/extra messages added to Slack as attachments are in a short style 'includeContextAndExtra' => true, // Optional: Whether the attachment should include context and extra data 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => false, // Optional: Whether the messages that are handled can bubble up the stack or not 'excludeFields' => ['context.field1', 'extra.field2'], // Optional: Dot separated list of fields to exclude from slack message. 'timeout' => 10.0, // Optional 'writeTimeout' => 5.0, // Optional 'persistent' => false, // Optional 'chunkSize' => 100, // Optional 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: SlackHandler
SendGridHandler
Sends emails via the SendGrid API. Requires the curl Excension.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'sendgrid', 'options' => [ 'apiUser' => 'apiUser', // The SendGrid API User 'apiKey' => 'apiKey', // The SendGrid API Key 'from' => 'from', // The sender of the email 'to' => 'to', // string or array of recipients 'subject' => 'subject', // The subject of the mail 'level' => \Psr\Log\LogLevel::INFO, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => false, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: SendGridHandler
MandrillHandler
Sends emails via the Mandrill API using a Swift_Message instance. Requires the curl Excension.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'mandrill', 'options' => [ 'apiKey' => 'my-service', // A valid Mandrill API key 'message' => 'my-message', // An example \Swiftmail message for real messages, only the body will be replaced. Must be a valid service name or callable 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: MandrillHandler
FleepHookHandler
Logs records to a Fleep conversation using Webhooks. Requires the openssl and sockets Extensions.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'fleepHook', 'options' => [ 'token' => 'sometokenhere', // Webhook token 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'timeout' => 10.0, // Optional 'writeTimeout' => 5.0, // Optional 'persistent' => false, // Optional 'chunkSize' => 100, // Optional 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: FleepHookHandler
IFTTTHandler
IFTTTHandler uses cURL to trigger IFTTT Maker actions. Requires the curl Extensions.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'ifttt', 'options' => [ 'eventName' => 'eventName', // name of an event 'secretKey' => 'secretKey', 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: IFTTTHandler
TelegramBotHandler
Logs records to a Telegram bot account. Requires the curl Excension.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'telegrambot', 'options' => [ 'apiKey' => 'api-key', // Api Key 'channel' => 'channel', // Channel 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'parseMode' => null, // Optional: null or one of 'HTML', 'MarkdownV2', 'Markdown' 'disableWebPagePreview' => null, // Optional: null or boolean 'disableNotification' => null, // Optional: null or boolean 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: TelegramBotHandler
Log specific servers and networked logging
SocketHandler
Logs records to sockets, use this for UNIX and TCP sockets. See an example. Requires the sockets Extension.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'socket', 'options' => [ 'connectionString' => 'unix:///var/log/httpd_app_log.socket', // Socket connection string. You can use a unix:// prefix to access unix sockets and udp:// to open UDP sockets instead of the default TCP. 'timeout' => 30.0, // Optional: The connection timeout, in seconds. 'writeTimeout' => 90.0, // Optional: Set timeout period on a stream. 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'persistent' => false, // Optional 'chunkSize' => 100, // Optional 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: SocketHandler
AmqpHandler
Logs records to an AMQP compatible server. Requires the php-amqp extension (1.0+) or the php-amqplib library.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'amqp', 'options' => [ 'exchange' => 'my-service', // AMQPExchange (php AMQP ext) or PHP AMQP lib channel. Must be a valid service. 'exchangeName' => 'log-name', // Optional: Exchange name, for AMQPChannel (PhpAmqpLib) only 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: AmqpHandler
GelfHandler
Logs records to a Graylog server. Requires package graylog2/gelf-php.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'gelf', 'options' => [ 'publisher' => 'my-service', // A Gelf\PublisherInterface object. Must be a valid service. 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: GelfHandler
ZendMonitorHandler
Logs records to the Zend Monitor present in Zend Server.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'zend', 'options' => [ 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: ZendMonitorHandler
NewRelicHandler
Logs records to a NewRelic application. Requires the newrelic Extension.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'newRelic', 'options' => [ 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'appName' => 'my-app', // Optional: Application name 'explodeArrays' => false, // Optional: Explode Arrays 'transactionName' => 'my-transaction', // Optional: Explode Arrays 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: NewRelicHandler
LogglyHandler
Logs records to a Loggly account. Requires the curl Excension.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'loggly', 'options' => [ 'token' => 'sometokenhere', // Webhook token 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: LogglyHandler
RollbarHandler
Logs records to a Rollbar account.
_Note: RollerbarHandler is out of date with upstream changes. In addition the Rollerbar library suggests using the PsrHandler instead. See Rollerbar Docs for how to set this up.
Monolog Docs: RollbarHandler
SyslogUdpHandler
Logs records to a remote Syslogd server. Requires the sockets Extension.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'syslogUdp', 'options' => [ 'host' => 'somewhere.com', // Host 'port' => 513, // Optional: Port 'facility' => 'Me', // Optional: Facility 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'ident' => 'me-too', // Optional: Program name or tag for each log message. 'rfc' => '', // Optional 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: SyslogUdpHandler
LogEntriesHandler
Logs records to a LogEntries account. Requires the openssl and sockets Extensions.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'logEntries', 'options' => [ 'token' => 'sometokenhere', // Log token supplied by LogEntries 'useSSL' => true, // Optional: Whether or not SSL encryption should be used. 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'timeout' => 10.0, // Optional 'writeTimeout' => 5.0, // Optional 'persistent' => false, // Optional 'chunkSize' => 100, // Optional 'host' => 'data.logentries.com', // Optional 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: LogEntriesHandler
InsightOpsHandler
Logs records to an InsightOps account. Requires the openssl and sockets Extensions.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'insightops', 'options' => [ 'token' => 'sometokenhere', // Log token supplied by InsightOps 'region' => 'region', // Region where InsightOps account is hosted. Could be 'us' or 'eu'. 'useSSL' => true, // Optional: Whether or not SSL encryption should be used. 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'timeout' => 10.0, // Optional 'writeTimeout' => 5.0, // Optional 'persistent' => false, // Optional 'chunkSize' => 100, // Optional 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: InsightOpsHandler
LogmaticHandler
Logs records to a Logmatic account. Requires the openssl and sockets Extensions.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'logmatic', 'options' => [ 'token' => 'sometokenhere', // Log token supplied by Logmatic. 'hostname' => 'region', // Optional: Host name supplied by Logmatic. 'appname' => 'region', // Optional: Application name supplied by Logmatic. 'useSSL' => true, // Optional: Whether or not SSL encryption should be used. 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'timeout' => 10.0, // Optional 'writeTimeout' => 5.0, // Optional 'persistent' => false, // Optional 'chunkSize' => 100, // Optional 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: LogmaticHandler
SqsHandler
Logs records to an AWS SQS queue.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'sqs', 'options' => [ 'sqsClient' => 'my-service', // SQS Client. Must be a valid service name in the container. 'queueUrl' => 'url', // URL to SQS Queue 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: SqsHandler
Logging in Development
FirePHPHandler
Handler for FirePHP, providing inline console messages within FireBug.
Note: The Firebug extension isn't being developed or maintained any longer.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'firePHP', 'options' => [ 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: FirePHPHandler
ChromePHPHandler
Handler for ChromePHP, providing inline console messages within Chrome. Requires the json Extension.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'chromePHP', 'options' => [ 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: ChromePHPHandler
BrowserConsoleHandler
Handler to send logs to browser's Javascript console with no browser extension required. Most browsers supporting console API are supported.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'browserConsole', 'options' => [ 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: BrowserConsoleHandler
Log to databases
RedisHandler
Logs records to a Redis server. Requires the php-redis extension or the Predis library.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'redis', 'options' => [ 'client' => 'my-redis-service-name', // The redis instance. Must be either a [Predis] client OR a Pecl Redis instance 'key' => 'my-service', // The key name to push records to 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'capSize' => true, // Optional: Number of entries to limit list size to, 0 = unlimited 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: RedisHandler
RedisPubSubHandler
Logs records to a Redis server. Requires the php-redis extension or the Predis library.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'redisPubSub', 'options' => [ 'client' => 'my-redis-service-name', // The redis instance. Must be either a [Predis] client OR a Pecl Redis instance 'key' => 'my-service', // The key name to push records to 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: RedisPubSubHandler
MongoDBHandler
Handler to write records in MongoDB via a Mongo extension connection.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'mongo', 'options' => [ 'client' => 'my-mongo-service-name', // MongoDB library or driver instance. 'database' => 'my-db', // Database name 'collection' => 'collectionName', // Collection name 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: MongoDBHandler
CouchDBHandler
Logs records to a CouchDB server.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'couchDb', 'options' => [ 'host' => 'localhost', // Optional: Hostname/Ip address, Default: 'localhost' 'port' => 5984, // Optional: port, Default: 5984 'dbname' => 'db', // Optional: Database Name, Default: 'logger' 'username' => 'someuser', // Optional: Username, Default: null 'password' => 'somepass', // Optional: Password, Default: null 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: CouchDBHandler
DoctrineCouchDBHandler
Logs records to a CouchDB server via the Doctrine CouchDB ODM.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'doctrineCouchDb', 'options' => [ 'client' => 'my-service', // CouchDBClient service name. Must be a valid container service 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: DoctrineCouchDBHandler
ElasticaHandler
Logs records to an Elastic Search server. Requires Elastica.
Note: The version of the client should match the server version, but there is actually no 8.x version.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'elastica', 'options' => [ 'client' => 'my-service', // Elastica Client object. Must be a valid container service 'index' => 'log', // Optional: Elastic index name 'type' => 'record', // Optional: Elastic document type 'ignoreError' => false, // Optional: Suppress Elastica exceptions 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: ElasticaHandler
ElasticsearchHandler
Logs records to an Elastic Search server. Requires the Elasticsearch PHP client.
Note: The version of the client should match the server version.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'elasticsearch', 'options' => [ 'client' => 'my-service', // Elastica Client object. Must be a valid container service 'index' => 'log', // Optional: Elastic index name 'dateFormat' => \Mimmi20\MonologFactory\Handler\ElasticsearchHandlerFactory::INDEX_PER_DAY, // Optional: possible Values are \Mimmi20\MonologFactory\Handler\ElasticsearchHandlerFactory::INDEX_PER_DAY, \Mimmi20\MonologFactory\Handler\ElasticsearchHandlerFactory::INDEX_PER_MONTH and \Mimmi20\MonologFactory\Handler\ElasticsearchHandlerFactory::INDEX_PER_YEAR 'indexNameFormat' => '{indexname}', // Optional: a string which must contain the string '{indexname}' (which is a placeholder for the `index`) and may contain the string '{date}' (which is a placeholder for the actual date formatted by `dateFormat`) 'type' => 'record', // Optional: Elastic document type 'ignoreError' => false, // Optional: Suppress Elastica exceptions 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: ElasticsearchHandler
DynamoDbHandler
Logs records to a DynamoDB table with the AWS SDK.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'dynamoDb', 'options' => [ 'client' => 'my-service', // DynamoDbClient object. Must be a valid container service 'table' => 'log', // Table name 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: DynamoDbHandler
Wrappers / Special Handlers
FingersCrossedHandler
A very interesting wrapper. It takes a logger as parameter and will accumulate log records of all levels until a record exceeds the defined severity level. At which point it delivers all records, including those of lower severity, to the handler it wraps. This means that until an error actually happens you will not see anything in your logs, but when it happens you will have the full information, including debug and info records. This provides you with all the information you need, but only when you need it.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'fingersCrossed', 'options' => [ 'handler' => [], // Required: Registered Handler to wrap 'activationStrategy' => 'my-service', // Optional: Strategy which determines when this handler takes action. Must be either the error level or configured ActivationStrategyInterface service 'bufferSize' => 0, // Optional: How many entries should be buffered at most, beyond that the oldest items are removed from the buffer. 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'stopBuffering' => true, // Optional: Whether the handler should stop buffering after being triggered (default true) 'passthruLevel' => null, // Optional: Minimum level to always flush to handler on close, even if strategy not triggered 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: FingersCrossedHandler
DeduplicationHandler
Useful if you are sending notifications or emails when critical errors occur. It takes a logger as parameter and will accumulate log records of all levels until the end of the request (or flush() is called). At that point it delivers all records to the handler it wraps, but only if the records are unique over a given time period (60 seconds by default). If the records are duplicates they are simply discarded. The main use of this is in case of critical failure like if your database is unreachable for example all your requests will fail and that can result in a lot of notifications being sent. Adding this handler reduces the amount of notifications to a manageable level.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'deduplication', 'options' => [ 'handler' => [], // Required: Registered Handler to wrap 'deduplicationStore' => '/tmp/somestore', // Optional: The file/path where the deduplication log should be kept 'deduplicationLevel' => \Psr\Log\LogLevel::ERROR, // Optional:The minimum logging level for log records to be looked at for deduplication purposes 'time' => 60, // Optional: The period (in seconds) during which duplicate entries should be suppressed after a given log is sent through 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: DeduplicationHandler
WhatFailureGroupHandler
This handler extends the GroupHandler ignoring exceptions raised by each child handler. This allows you to ignore issues where a remote tcp connection may have died but you do not want your entire application to crash and may wish to continue to log to other handlers.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'whatFailureGroup', 'options' => [ 'handlers' => [], // Required: Array of Handlers to wrap 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: WhatFailureGroupHandler
FallbackGroupHandler
This handler extends the GroupHandler ignoring exceptions raised by each child handler, until one has handled without throwing. This allows you to ignore issues where a remote tcp connection may have died but you do not want your entire application to crash and may wish to continue to attempt log to other handlers, until one does not throw.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'fallbackgroup', 'options' => [ 'handlers' => [], // Required: Array of Registered Handlers to wrap 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: FallbackGroupHandler
BufferHandler
This handler will buffer all the log records it receives until close() is called at which point it will call handleBatch() on the handler it wraps with all the log messages at once. This is very useful to send an email with all records at once for example instead of having one mail for every log record.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'buffer', 'options' => [ 'handler' => [], // Required: Registered Handler to wrap 'bufferLimit' => 0, // Optional: How many entries should be buffered at most, beyond that the oldest items are removed from the buffer. 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'flushOnOverflow' => true, // Optional: If true, the buffer is flushed when the max size has been reached, by default oldest entries are discarded 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: BufferHandler
GroupHandler
This handler groups other handlers. Every record received is sent to all the handlers it is configured with.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'group', 'options' => [ 'handlers' => [], // Required: Array of Registered Handlers to wrap 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: GroupHandler
FilterHandler
Simple handler wrapper that filters records based on a list of levels
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'filter', 'options' => [ 'handler' => [], // Required: Registered Handler to wrap 'minLevelOrList' => \Psr\Log\LogLevel::DEBUG, // Optional: An array of levels to accept or a minimum level if maxLevel is provided 'maxLevel' => \Psr\Log\LogLevel::EMERGENCY, // Optional: Maximum level to accept, only used if $minLevelOrList is not an array 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: FilterHandler
SamplingHandler
A sampled event stream can be useful for logging high frequency events in a production environment where you only need an idea of what is happening and are not concerned with capturing every occurrence. Since the decision to handle or not handle a particular event is determined randomly, the resulting sampled log is not guaranteed to contain 1/N of the events that occurred in the application, but based on the Law of large numbers, it will tend to be close to this ratio with a large number of attempts.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'sampling', 'options' => [ 'handler' => [], // Required: Registered Handler to wrap 'factor' => 5, // Required: Sample factor 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: SamplingHandler
NoopHandler
This handler handles anything by doing nothing. It does not stop processing the rest of the stack. This can be used for testing, or to disable a handler when overriding a configuration.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'noop', 'options' => [], ], ], ], ], ];
Monolog Docs: NoopHandler
NullHandler
Any record it can handle will be thrown away. This can be used to put on top of an existing stack to override it temporarily.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'null', 'options' => [ 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered ], ], ], ], ], ];
Monolog Docs: NullHandler
PsrHandler
Can be used to forward log records to an existing PSR-3 logger
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'psr', 'options' => [ 'logger' => 'loggerService', // Required: Logger Service to wrap from the container 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. ], ], ], ], ], ];
Monolog Docs: PsrHandler
TestHandler
Used for testing, it records everything that is sent to it and has accessors to read out the information.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'test', 'options' => [ 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: TestHandler
OverflowHandler
This handler will buffer all the log messages it receives, up until a configured threshold of number of messages of a certain lever is reached, after it will pass all log messages to the wrapped handler. Useful for applying in batch processing when you're only interested in significant failures instead of minor, single erroneous events.
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'overflow', 'options' => [ 'handler' => [], // Required: Registered Handler to wrap 'thresholdMap' => [ // Optional: threshold map 'debug' => 0, // Optional: debug threshold. Default: 0 'info' => 0, // Optional: info threshold. Default: 0 'notice' => 0, // Optional: notice threshold. Default: 0 'warning' => 0, // Optional: warning threshold. Default: 0 'error' => 0, // Optional: error threshold. Default: 0 'critical' => 0, // Optional: critical threshold. Default: 0 'alert' => 0, // Optional: alert threshold. Default: 0 'emergency' => 0, // Optional: emergency threshold. Default: 0 ], 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Monolog Docs: OverflowHandler
3rd Party Handlers
MicrosoftTeamsHandler
Sends Records to a Microsoft Teams Webhook. Requires package actived/microsoft-teams-notifier
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'microsoft-teams', 'options' => [ 'url' => '', // Required: Url of the MS Teams Webhook 'title' => '', // Optional: Default Message Title 'subject' => '', // Optional: Message Subject 'emoji' => '', // Optional: custom emoji for the Message (added to the title) 'color' => '', // Optional: custom color for the Message 'format' => '', // Optional: Message format (only used in the default formatter) 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
TeamsLogHandler
Sends Records to a Microsoft Teams Webhook. Requires package cmdisp/monolog-microsoft-teams
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'teams', 'options' => [ 'url' => '', // Required: Url of the MS Teams Webhook 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'formatter' => [], // Optional: Formatter for the handler. 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
CallbackFilterHandler
Filters Records with a Callback function. Requires bartlett/monolog-callbackfilterhandler
<?php return [ 'log' => [ 'default' => [ 'handlers' => [ 'myHandlerName' => [ 'type' => 'callbackfilter', 'options' => [ 'handler' => [], // Required: Registered Handler to wrap 'filters' => [], // Optional: An array of callback functions 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this handler will be triggered 'bubble' => true, // Optional: Whether the messages that are handled can bubble up the stack or not 'processors' => [], // Optional: Processors for the handler. ], ], ], ], ], ];
Formatters
LineFomatter
Formats a log record into a one-line string.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'line', 'options' => [ 'format' => "[%datetime%] %channel%.%level_name%: %message% %context% %extra%\n", // Optional 'dateFormat' => "c", // Optional : The format of the timestamp: one supported by DateTime::format 'allowInlineLineBreaks' => false, // Optional : Whether to allow inline line breaks in log entries 'ignoreEmptyContextAndExtra' => false, // Optional 'includeStacktraces' => false, // Optional 'maxNormalizeDepth' => 9, // Optional 'maxNormalizeItemCount' => 1000, // Optional 'prettyPrint' => false, // Optional ], ], ], ], ], ];
Monolog Docs: LineFormatter
HtmlFormatter
Used to format log records into a human readable html table, mainly suitable for emails.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'html', 'options' => [ 'dateFormat' => "c", // Optional 'maxNormalizeDepth' => 9, // Optional 'maxNormalizeItemCount' => 1000, // Optional 'prettyPrint' => false, // Optional ], ], ], ], ], ];
Monolog Docs: HtmlFormatter
NormalizerFormatter
Normalizes objects/resources down to strings so a record can easily be serialized/encoded. Requires the json Extension.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'normalizer', 'options' => [ 'dateFormat' => "c", // Optional 'maxNormalizeDepth' => 9, // Optional 'maxNormalizeItemCount' => 1000, // Optional 'prettyPrint' => false, // Optional ], ], ], ], ], ];
Monolog Docs: NormalizerFormatter
ScalarFormatter
Used to format log records into an associative array of scalar values.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'scalar', 'options' => [ 'dateFormat' => "c", // Optional 'maxNormalizeDepth' => 9, // Optional 'maxNormalizeItemCount' => 1000, // Optional 'prettyPrint' => false, // Optional ], ], ], ], ], ];
Monolog Docs: ScalarFormatter
JsonFormatter
Encodes a log record into json.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'json', 'options' => [ 'batchMode' => \Monolog\Formatter\JsonFormatter::BATCH_MODE_JSON, // Optional 'appendNewline' => true, // Optional 'ignoreEmptyContextAndExtra' => false, // Optional 'includeStacktraces' => false, // Optional 'dateFormat' => "c", // Optional 'maxNormalizeDepth' => 9, // Optional 'maxNormalizeItemCount' => 1000, // Optional 'prettyPrint' => false, // Optional ], ], ], ], ], ];
Monolog Docs: JsonFormatter
WildfireFormatter
Used to format log records into the Wildfire/FirePHP protocol, only useful for the FirePHPHandler.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'wildfire', 'options' => [ 'dateFormat' => "c", // Optional 'maxNormalizeDepth' => 9, // Optional 'maxNormalizeItemCount' => 1000, // Optional 'prettyPrint' => false, // Optional ], ], ], ], ], ];
Monolog Docs: WildfireFormatter
ChromePHPFormatter
Used to format log records into the ChromePHP format, only useful for the ChromePHPHandler.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'chromePHP', 'options' => [], // No options available ], ], ], ], ];
Monolog Docs: ChromePHPFormatter
GelfMessageFormatter
Used to format log records into Gelf message instances, only useful for the GelfHandler.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'gelf', 'options' => [ 'systemName' => "my-system", // Optional : the name of the system for the Gelf log message, defaults to the hostname of the machine 'extraPrefix' => "extra_", // Optional : a prefix for 'extra' fields from the Monolog record 'contextPrefix' => 'ctxt_', // Optional : a prefix for 'context' fields from the Monolog record 'maxLength' => 32766, // Optional : Length per field 'maxNormalizeDepth' => 9, // Optional 'maxNormalizeItemCount' => 1000, // Optional 'prettyPrint' => false, // Optional ], ], ], ], ], ];
Monolog Docs: GelfMessageFormatter
LogstashFormatter
Used to format log records into logstash event json, useful for any handler listed under inputs here.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'logstash', 'options' => [ 'applicationName' => 'app-name', // the application that sends the data, used as the "type" field of logstash 'systemName' => "my-system", // Optional : the system/machine name, used as the "source" field of logstash, defaults to the hostname of the machine 'extraPrefix' => "extra_", // Optional : prefix for extra keys inside logstash "fields" 'contextPrefix' => 'ctxt_', // Optional : prefix for context keys inside logstash "fields", defaults to ctxt_ 'maxNormalizeDepth' => 9, // Optional 'maxNormalizeItemCount' => 1000, // Optional 'prettyPrint' => false, // Optional ], ], ], ], ], ];
Monolog Docs: LogstashFormatter
ElasticaFormatter
Used to format log records into an Elastica Document.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'ElasticaFormatter' => [ 'type' => 'elastica', 'options' => [ 'index' => 'some-index', // Elastic search index name 'type' => "doc-type", // Elastic search document type 'maxNormalizeDepth' => 9, // Optional 'maxNormalizeItemCount' => 1000, // Optional 'prettyPrint' => false, // Optional ], ], ], ], ], ];
Monolog Docs: ElasticaFormatter
ElasticsearchFormatter
Used to format log records into an Elasticsearch Document.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'ElasticsearchFormatter' => [ 'type' => 'elasticsearch', 'options' => [ 'index' => 'some-index', // Elastic search index name 'type' => "doc-type", // Elastic search document type 'maxNormalizeDepth' => 9, // Optional 'maxNormalizeItemCount' => 1000, // Optional 'prettyPrint' => false, // Optional ], ], ], ], ], ];
Monolog Docs: ElasticsearchFormatter
LogglyFormatter
Used to format log records into Loggly messages, only useful for the LogglyHandler.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'loggly', 'options' => [ 'batchMode' => \Monolog\Formatter\JsonFormatter::BATCH_MODE_NEWLINES, // Optional 'appendNewline' => false, // Optional 'includeStacktraces' => false, // Optional 'dateFormat' => "c", // Optional 'maxNormalizeDepth' => 9, // Optional 'maxNormalizeItemCount' => 1000, // Optional 'prettyPrint' => false, // Optional ], ], ], ], ], ];
Monolog Docs: LogglyFormatter
FlowdockFormatter
Used to format log records into Flowdock messages, only useful for the FlowdockHandler.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'flowdock', 'options' => [ 'source' => 'Some Source', 'sourceEmail' => 'source@email.com' ], ], ], ], ], ];
Monolog Docs: FlowdockFormatter
MongoDBFormatter
Converts \DateTime instances to \MongoDate and objects recursively to arrays, only useful with the MongoDBHandler.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'mongodb', 'options' => [ 'maxNestingLevel' => 3, // optional : 0 means infinite nesting, the $record itself is level 1, $record['context'] is 2 'exceptionTraceAsString' => true, // optional : set to false to log exception traces as a sub documents instead of strings ], ], ], ], ], ];
Monolog Docs: MongoDBFormatter
LogmaticFormatter
User to format log records to Logmatic messages, only useful for the LogmaticHandler.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'logmatic', 'options' => [ 'batchMode' => \Monolog\Formatter\LogmaticFormatter::BATCH_MODE_JSON, // Optional 'appendNewline' => true, // Optional 'ignoreEmptyContextAndExtra' => false, // Optional 'includeStacktraces' => false, // Optional 'dateFormat' => "c", // Optional 'maxNormalizeDepth' => 9, // Optional 'maxNormalizeItemCount' => 1000, // Optional 'prettyPrint' => false, // Optional ], ], ], ], ], ];
Monolog Docs: LogmaticFormatter
FluentdFormatter
Serializes a log message to Fluentd unix socket protocol. Requires the json Extension.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'fluentd', 'options' => [ 'levelTag' => false, // Optional ], ], ], ], ], ];
Monolog Docs: FluentdFormatter
StreamFormatter
Formats the message using a symfony table. Requires StreamFormatter.
<?php return [ 'log' => [ 'default' => [ 'formatters' => [ 'myFormatterName' => [ 'type' => 'stream', 'options' => [ 'format' => "%message%", // Optional 'tableStyle' => 'box', // Optional 'dateFormat' => "c", // Optional : The format of the timestamp: one supported by DateTime::format 'allowInlineLineBreaks' => false, // Optional : Whether to allow inline line breaks in log entries 'includeStacktraces' => false, // Optional 'maxNormalizeDepth' => 9, // Optional 'maxNormalizeItemCount' => 1000, // Optional 'prettyPrint' => false, // Optional ], ], ], ], ], ];
Processors
PsrLogMessageProcessor
Processes a log record's message according to PSR-3 rules, replacing {foo} with the value from $context['foo'].
<?php return [ 'log' => [ 'default' => [ 'processors' => [ 'myProcessorsName' => [ 'type' => 'psrLogMessage', 'options' => [ 'dateFormat' => "c", // Optional 'removeUsedContextFields' => false, // Optional ], ], ], ], ], ];
Monolog Docs: PsrLogMessageProcessor
IntrospectionProcessor
Adds the line/file/class/method from which the log call originated.
<?php return [ 'log' => [ 'default' => [ 'processors' => [ 'myProcessorsName' => [ 'type' => 'introspection', 'options' => [ 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this processor will be triggered 'skipClassesPartials' => [], // Optional 'skipStackFramesCount' => 0, // Optional ], ], ], ], ], ];
Monolog Docs: IntrospectionProcessor
WebProcessor
Adds the current request URI, request method and client IP to a log record.
<?php return [ 'log' => [ 'default' => [ 'processors' => [ 'myProcessorsName' => [ 'type' => 'web', 'options' => [ 'serverData' => 'my-service', // Optional: Array, object w/ ArrayAccess, or valid service name that provides access to the $_SERVER data 'extraFields' => [], // Optional: Field names and the related key inside $serverData to be added. If not provided it defaults to: url, ip, http_method, server, referrer ], ], ], ], ], ];
Monolog Docs: WebProcessor
MemoryUsageProcessor
Adds the current memory usage to a log record.
<?php return [ 'log' => [ 'default' => [ 'processors' => [ 'myProcessorsName' => [ 'type' => 'memoryUsage', 'options' => [ 'realUsage' => true, 'useFormatting' => true, ], ], ], ], ], ];
Monolog Docs: MemoryUsageProcessor
MemoryPeakUsageProcessor
Adds the peak memory usage to a log record.
<?php return [ 'log' => [ 'default' => [ 'processors' => [ 'myProcessorsName' => [ 'type' => 'memoryPeak', 'options' => [ 'realUsage' => true, 'useFormatting' => true, ], ], ], ], ], ];
Monolog Docs: MemoryPeakUsageProcessor
ProcessIdProcessor
Adds the process id to a log record.
<?php return [ 'log' => [ 'default' => [ 'processors' => [ 'myProcessorsName' => [ 'type' => 'processId', 'options' => [], // No options ], ], ], ], ];
Monolog Docs: ProcessIdProcessor
UidProcessor
Adds a unique identifier to a log record.
<?php return [ 'log' => [ 'default' => [ 'processors' => [ 'myProcessorsName' => [ 'type' => 'uid', 'options' => [ 'length' => 7, // Optional: The uid length. Must be an integer between 1 and 32 ], ], ], ], ], ];
Monolog Docs: UidProcessor
GitProcessor
Adds the current git branch and commit to a log record.
Note: Only works if the git executable is in your working path.
<?php return [ 'log' => [ 'default' => [ 'processors' => [ 'myProcessorsName' => [ 'type' => 'git', 'options' => [ 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this processor will be triggered ], ], ], ], ], ];
Monolog Docs: GitProcessor
MercurialProcessor
Adds the current hg branch and commit to a log record.
Note: Only works if the hg executable is in your working path.
<?php return [ 'log' => [ 'default' => [ 'processors' => [ 'myProcessorsName' => [ 'type' => 'mercurial', 'options' => [ 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this processor will be triggered ], ], ], ], ], ];
Monolog Docs: MercurialProcessor
TagProcessor
Adds an array of predefined tags to a log record.
<?php return [ 'log' => [ 'default' => [ 'processors' => [ 'myProcessorsName' => [ 'type' => 'tags', 'options' => [ 'tags' => [], // Optional: Array of tags to add to records ], ], ], ], ], ];
Monolog Docs: TagProcessor
HostnameProcessor
Adds the current hostname to a log record.
<?php return [ 'log' => [ 'default' => [ 'processors' => [ 'myProcessorsName' => [ 'type' => 'hostname', 'options' => [], // No options ], ], ], ], ];
Monolog Docs: HostnameProcessor
RequestHeaderProcessor
Adds Request Headers to a log record. Requires jk/monolog-request-header-processor
<?php return [ 'log' => [ 'default' => [ 'processors' => [ 'myProcessorsName' => [ 'type' => 'requestheader', 'options' => [ 'level' => \Psr\Log\LogLevel::DEBUG, // Optional: The minimum logging level at which this processor will be triggered ], ], ], ], ], ];
License
This package is licensed using the MIT License.
Please have a look at LICENSE.md
.