Monolog-PHP日志类库

Monolog-PHP⽇志类库
(转载)
Monolog是php下⽐较全⼜容易扩展的记录⽇志类库。

⽬前有包括Symfony 、Laravel、 CakePHP等诸多知名php框架都内置了Monolog。

Monolog可以把你的⽇志发送到⽂件，sockets，收件箱，数据库和各种web services。

Monolog遵循PSR3的接⼝规范，可以很轻易的替换成其他遵循同⼀规范的⽇志类库。

Monolog具有良好的扩展性，通过Handler、Formatter 和Processor这⼏个接⼝，可以对Monolog类库进⾏各种扩展和⾃定义。

基本⽤法
可以通过github或者composer安装Monolog，以下是使⽤composer安装最新版本：
composer require monolog/monolog
如果您还不了解composer是什么？
要求PHP版本为5.3以上。

<?php
use Monolog\Logger;
use Monolog\Handler\StreamHandler;
// 创建⽇志频道
$log = new Logger('name');
$log->pushHandler(new StreamHandler('path/to/your.log', Logger::WARNING));
// 添加⽇志记录
$log->addWarning('Foo');
$log->addError('Bar');
核⼼概念
每⼀个Logger实例都包含⼀个频道名(channel)和handler的堆栈。

当你添加⼀条记录时，记录会依次通过handler堆栈的处理。

⽽每个handler也可以决定是否把记录传递到下⼀个堆栈⾥的下⼀个handler。

通过handler，我们可以实现⼀些复杂的⽇志操作。

例如我们把StreamHandler放在堆栈的最下⾯，那么所有的⽇志记录最终都会写到硬盘⽂件⾥。

同时我们把MailHandler放在堆栈的最上⾯，通过设置⽇志等级把错误⽇志通过邮件发送出去。

Handler⾥有个$bubble属性，这个属性定义了handler是否拦截记录不让它流到下⼀个handler。

所以如果我们把MailHandler的$bubble参数设置为false，则出现错误⽇志时，⽇志会通过MailHandler发送出去，⽽不会经过StreamHandler写到硬盘上。

Logger可以创建多个，每个都可以定义⾃⼰的频道名和handler堆栈。

handler可以在多个Logger中共享。

频道名会反映在⽇志⾥，⽅便我们查看和过滤⽇志记录。

如果没有指定⽇志格式（Formatter），Handler会使⽤默认的Formatter。

⽇志的等级不能⾃定义，⽬前使⽤的是RFC 5424⾥定义的8个等级：debug、info、notice、warning、error、critical、alert和emergency。

如果对⽇志记录有其他的需求，可以通过Processo对⽇志记录添加内容。

⽇志等级
DEBUG (100): 详细的debug信息。

INFO (200): 关键事件。

NOTICE (250): 普通但是重要的事件。

WARNING (300): 出现⾮错误的异常。

ERROR (400): 运⾏时错误，但是不需要⽴刻处理。

CRITICA (500): 严重错误。

EMERGENCY (600): 系统不可⽤。

⽤法详解
多个handler
<?php
use Monolog\Logger;
use Monolog\Handler\StreamHandler;
use Monolog\Handler\FirePHPHandler;
// 创建Logger实例
$logger = new Logger('my_logger');
// 添加handler
$logger->pushHandler(new StreamHandler(__DIR__.'/my_app.log', Logger::DEBUG));
$logger->pushHandler(new FirePHPHandler());
// 开始使⽤
$logger->addInfo('My logger is now ready');
第⼀步我们先创建⼀个Logger实例，传⼊的是频道名，这个频道名可以⽤于区分多个Logger实例。

实例本⾝并不知道如何处理⽇志记录，它是通过handler进⾏处理的。

handler可以设置多个，例如上⾯的例⼦设置了两个handler，可以对⽇志记录进⾏两种不同⽅式的处理。

需要注意的是，由于handler是采⽤堆栈的⽅式保存，所以后⾯添加的handler位于栈顶，会⾸先被调⽤。

添加额外的数据
Monolog有两种⽅式对⽇志添加额外的信息。

第⼀个⽅法是使⽤上下⽂，使⽤$context参数，传⼊⼀个数组：
<?php
$logger->addInfo('Adding a new user', array('username' => 'Seldaek'));
第⼆个⽅法是使⽤processor。

processor可以是任何可调⽤的⽅法，这些⽅法把⽇志记录作为参数，然后经过处理修改extra部分后返回。

<?php
$logger->pushProcessor(function ($record) {
$record['extra']['dummy'] = 'Hello world!';
return $record;
});
Processor不⼀定要绑定在Logger实例上，也可以绑定到某个具体的handler上。

使⽤handler实例的pushProcessor⽅法进⾏绑定。

频道的使⽤
使⽤频道名可以对⽇志进⾏分类，这在⼤型的应⽤上是很有⽤的。

通过频道名，可以很容易的对⽇志记录进⾏刷选。

例如我们想在同⼀个⽇志⽂件⾥记录不同模块的⽇志，我们可以把相同的handler绑定到不同的Logger实例上，这些实例使⽤不同的频道名：
<?php
use Monolog\Logger;
use Monolog\Handler\StreamHandler;
use Monolog\Handler\FirePHPHandler;
// 创建handler
$stream = new StreamHandler(__DIR__.'/my_app.log', Logger::DEBUG);
$firephp = new FirePHPHandler();
// 创建应⽤的主要logger
$logger = new Logger('my_logger');
$logger->pushHandler($stream);
$logger->pushHandler($firephp);
// 通过不同的频道名创建⼀个⽤于安全相关的logger
$securityLogger = new Logger('security');
$securityLogger->pushHandler($stream);
$securityLogger->pushHandler($firephp);
Handler
Monolog内置很多很实⽤的handler，它们⼏乎囊括了各种的使⽤场景，这⾥介绍⼀些使⽤的：
StreamHandler：把记录写进PHP流，主要⽤于⽇志⽂件。

SyslogHandler：把记录写进syslog。

ErrorLogHandler：把记录写进PHP错误⽇志。

NativeMailerHandler：使⽤PHP的mail()函数发送⽇志记录。

SocketHandler：通过socket写⽇志。

<?php
use Monolog\Logger;
use Monolog\Handler\SocketHandler;
// Create the logger
$logger = new Logger('my_logger');
// Create the handler
$handler = new SocketHandler('unix:///var/log/httpd_app_log.socket');
$handler->setPersistent(true);
// Now add the handler
$logger->pushHandler($handler, Logger::DEBUG);
// You can now use your logger
$logger->addInfo('My logger is now ready');
AmqpHandler：把记录写进兼容amqp协议的服务。

BrowserConsoleHandler：把⽇志记录写到浏览器的控制台。

由于是使⽤浏览器的console对象，需要看浏览器是否⽀持。

RedisHandler：把记录写进Redis。

MongoDBHandler：把记录写进Mongo。

ElasticSearchHandler：把记录写到ElasticSearch服务。

BufferHandler：允许我们把⽇志记录缓存起来⼀次性进⾏处理。

Formatter
同样的，这⾥介绍⼏个⾃带的Formatter：
LineFormatter：把⽇志记录格式化成⼀⾏字符串。

HtmlFormatter：把⽇志记录格式化成HTML表格，主要⽤于邮件。

JsonFormatter：把⽇志记录编码成JSON格式。

LogstashFormatter：把⽇志记录格式化成logstash的事件JSON格式。

ElasticaFormatter：把⽇志记录格式化成ElasticSearch使⽤的数据格式。

Processor
前⾯说过，Processor可以为⽇志记录添加额外的信息，Monolog也提供了⼀些很实⽤的processor：IntrospectionProcessor：增加当前脚本的⽂件名和类名等信息。

WebProcessor：增加当前请求的URI、请求⽅法和访问IP等信息。

MemoryUsageProcessor：增加当前内存使⽤情况信息。

MemoryPeakUsageProcessor：增加内存使⽤⾼峰时的信息。