www.adminn.cn
站长正能量分享网!

Monolog PHP日志类库使用详解介绍

AD:阿里云服务器企业会员更优惠 腾讯云香港,韩国免备案服务器1.8折优惠

Monolog遵循PSR3的接口规范,可以很轻易的替换成其他遵循同一规范的日志类库。Monolog具有良好的扩展性,通过Handler、Formatter和Processor这几个接口,可以对Monolog类库进行各种扩展和自定义。

基本用法

可以通过github或者composer安装Monolog,以下是使用composer安装最新版本:

composer require monolog/monolog

如果您还不了解composer是什么? 请点这里。

要求PHP版本为5.3以上。

  1. use Monolog\Logger; 
  2. use Monolog\Handler\StreamHandler; 
  3.  
  4. // 创建日志频道 
  5. $log = new Logger('name'); 
  6. $log->pushHandler(new StreamHandler('path/to/your.log', Logger::WARNING)); 
  7.  
  8. // 添加日志记录 
  9. $log->addWarning('Foo'); 
  10. $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

  1. use Monolog\Logger; 
  2. use Monolog\Handler\StreamHandler; 
  3. use Monolog\Handler\FirePHPHandler; 
  4.  
  5. // 创建Logger实例 
  6. $logger = new Logger('my_logger'); 
  7. // 添加handler 
  8. $logger->pushHandler(new StreamHandler(__DIR__.'/my_app.log', Logger::DEBUG)); 
  9. $logger->pushHandler(new FirePHPHandler()); 
  10.  
  11. // 开始使用 
  12. $logger->addInfo('My logger is now ready'); 

第一步我们先创建一个Logger实例,传入的是频道名,这个频道名可以用于区分多个Logger实例。

实例本身并不知道如何处理日志记录,它是通过handler进行处理的。handler可以设置多个,例如上面的例子设置了两个handler,可以对日志记录进行两种不同方式的处理。

需要注意的是,由于handler是采用堆栈的方式保存,所以后面添加的handler位于栈顶,会首先被调用。

添加额外的数据

Monolog有两种方式对日志添加额外的信息。

第一个方法是使用上下文,使用$context参数,传入一个数组:

$logger->addInfo('Adding a new user', array('username' => 'Seldaek'));

第二个方法是使用processor。processor可以是任何可调用的方法,这些方法把日志记录作为参数,然后经过处理修改extra部分后返回。

  1. $logger->pushProcessor(function ($record) { 
  2.     $record['extra']['dummy'] = 'Hello world!'
  3.  
  4.     return $record
  5. }); 

Processor不一定要绑定在Logger实例上,也可以绑定到某个具体的handler上。使用handler实例的pushProcessor方法进行绑定。

频道的使用

使用频道名可以对日志进行分类,这在大型的应用上是很有用的。通过频道名,可以很容易的对日志记录进行刷选。

例如我们想在同一个日志文件里记录不同模块的日志,我们可以把相同的handler绑定到不同的Logger实例上,这些实例使用不同的频道名:

  1. use Monolog\Logger; 
  2. use Monolog\Handler\StreamHandler; 
  3. use Monolog\Handler\FirePHPHandler; 
  4.  
  5. // 创建handler 
  6. $stream = new StreamHandler(__DIR__.'/my_app.log', Logger::DEBUG); 
  7. $firephp = new FirePHPHandler(); 
  8.  
  9. // 创建应用的主要logger 
  10. $logger = new Logger('my_logger'); 
  11. $logger->pushHandler($stream); 
  12. $logger->pushHandler($firephp); 
  13. //phpfensi.com 
  14. // 通过不同的频道名创建一个用于安全相关的logger 
  15. $securityLogger = new Logger('security'); 
  16. $securityLogger->pushHandler($stream); 
  17. $securityLogger->pushHandler($firephp); 

Handler

Monolog内置很多很实用的handler,它们几乎囊括了各种的使用场景,这里介绍一些使用的:

StreamHandler:把记录写进PHP流,主要用于日志文件。

SyslogHandler:把记录写进syslog。

ErrorLogHandler:把记录写进PHP错误日志。

NativeMailerHandler:使用PHP的mail()函数发送日志记录。

SocketHandler:通过socket写日志。

  1. use Monolog\Logger; 
  2. use Monolog\Handler\SocketHandler; 
  3.  
  4. // Create the logger 
  5. $logger = new Logger('my_logger'); 
  6.  
  7. // Create the handler 
  8. $handler = new SocketHandler('unix:///var/log/httpd_app_log.socket'); 
  9. $handler->setPersistent(true); 
  10.  
  11. // Now add the handler 
  12. $logger->pushHandler($handler, Logger::DEBUG); 
  13.  
  14. // You can now use your logger 
  15. $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:增加内存使用高峰时的信息。

模板优惠价: (点击购买)
版权声明:本文采用知识共享 署名4.0国际许可协议 [BY-NC-SA] 进行授权
文章名称:《Monolog PHP日志类库使用详解介绍》
文章链接:https://www.adminn.cn/news/7588.html
本站资源模板仅供个人学习交流,请于下载后24小时内删除,不允许用于商业用途,否则法律问题自行承担。2021.5月起,网站调整,暂不再分享免费模板。谢谢理解

Adminn.Cn 站长分享圈

帝国CMS精品模板腾讯云优惠券,代金券

2次开发,学习研究使用!扫码支付后联系QQ677123发货!

支付宝扫一扫打赏