[PHP 类库] Monolog - Logging for PHP 5.3+
Monolog是PHP的一个日志类库。相比于其他的日志类库,它有以下的特点:
- 功能强大。可以把日志发送到文件、socket、邮箱、数据库和各种web services。
- 遵循PSR3的接口规范。可以很轻易的替换成其他遵循同一规范的日志类库。
- 良好的扩展性。通过
Handler
、Formatter
和Processor
这几个接口,可以对Monolog类库进行各种扩展和自定义。
基本用法
安装最新版本:
composer require monolog/monolog
要求PHP版本为5.3以上。
php
<?phpuse 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
<?phpuse 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
<?php$logger->addInfo('Adding a new user', array('username' => 'Seldaek'));
使用processor
第二个方法是使用processor。processor可以是任何可调用的方法,这些方法把日志记录作为参数,然后经过处理修改extra
部分后返回。
php
<?php$logger->pushProcessor(function ($record) {$record['extra']['dummy'] = 'Hello world!';return $record; });
Processor不一定要绑定在Logger实例上,也可以绑定到某个具体的handler上。使用handler实例的pushProcessor
方法进行绑定。
频道的使用
使用频道名可以对日志进行分类,这在大型的应用上是很有用的。通过频道名,可以很容易的对日志记录进行刷选。
例如我们想在同一个日志文件里记录不同模块的日志,我们可以把相同的handler绑定到不同的Logger实例上,这些实例使用不同的频道名:
php
<?phpuse 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
<?phpuse 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
:允许我们把日志记录缓存起来一次性进行处理。
更多的Handler请看 https://github.com/Seldaek/monolog#handlers。
Formatter
LineFormatter
:把日志记录格式化成一行字符串。HtmlFormatter
:把日志记录格式化成HTML表格,主要用于邮件。JsonFormatter
:把日志记录编码成JSON格式。LogstashFormatter
:把日志记录格式化成logstash的事件JSON格式。ElasticaFormatter
:把日志记录格式化成ElasticSearch使用的数据格式。
更多的Formatter请看 https://github.com/Seldaek/monolog#formatters。
Processor
前面说过,Processor可以为日志记录添加额外的信息,Monolog也提供了一些很实用的processor:
IntrospectionProcessor
:增加当前脚本的文件名和类名等信息。WebProcessor
:增加当前请求的URI、请求方法和访问IP等信息。MemoryUsageProcessor
:增加当前内存使用情况信息。MemoryPeakUsageProcessor
:增加内存使用高峰时的信息。
更多的Processor请看 https://github.com/Seldaek/monolog#processors。
扩展handler
php
<?phpuse Monolog\Logger; use Monolog\Handler\AbstractProcessingHandler;class PDOHandler extends AbstractProcessingHandler {private $initialized = false;private $pdo;private $statement;public function __construct(PDO $pdo, $level = Logger::DEBUG, $bubble = true){$this->pdo = $pdo;parent::__construct($level, $bubble);}protected function write(array $record){if (!$this->initialized) {$this->initialize();}$this->statement->execute(array('channel' => $record['channel'],'level' => $record['level'],'message' => $record['formatted'],'time' => $record['datetime']->format('U'),));}private function initialize(){$this->pdo->exec('CREATE TABLE IF NOT EXISTS monolog '.'(channel VARCHAR(255), level INTEGER, message LONGTEXT, time INTEGER UNSIGNED)');$this->statement = $this->pdo->prepare('INSERT INTO monolog (channel, level, message, time) VALUES (:channel, :level, :message, :time)');} }
php
<?php$logger->pushHandler(new PDOHandler(new PDO('sqlite:logs.sqlite'));// You can now use your logger $logger->addInfo('My logger is now ready');
参考
[PHP 类库] Monolog - Logging for PHP 5.3+相关推荐
- php 日志库,推荐一个好用的php日志类库,monolog/monolog
安装 $ composer require monolog/monolog 使用方法 use Monolog\Logger; use Monolog\Handler\StreamHandler; // ...
- tp5使用monolog_使用Monolog记录:从Devtools到Slack
tp5使用monolog Logging is an important part of the app development/maintenance cycle. It's not just ab ...
- 程序开发常用第三方类库一览表(VendorLib)
以下是自己开发过程中用到的第三方类库,记录下来方便查阅 ------------------------------------------------------------------------ ...
- 业务异步写mysql数据库_把重要的业务日志异步批量写入数据库
1. 把重要的业务日志异步批量写入数据库 配置文件示例: log4j.logger.business=INFO,db log4j.appender.db=org.apache.log4j.jdbc.J ...
- 自己做游戏(一)-PhotonServer配置
感觉时间过得好快,不知不觉接触Unity一年多了,当初学习Unity的目的就是为了自己做游戏,可惜现在的游戏行业一片混乱,各种卖情怀....(多的不想说了,颇有一种学医救不了中国的感觉),现在自己从事 ...
- Muduo网络库核心梳理
Muduo网络库 Muduo网络库本身并不复杂,是一个新手入门C++面向对象网络编程的经典实战项目.但是,新手在刚刚上手读代码的时候,非常容易陷入代码的汪洋大海,迷失方向.本文旨在简要梳理Muduo网 ...
- monolog 存入mysql_Monolog-PHP日志类库介绍
Monolog遵循PSR3的接口规范,可以很轻易的替换成其他遵循同一规范的日志类库.Monolog具有良好的扩展性,通过Handler.Formatter和Processor这几个接口,可以对Mono ...
- 收集整理一些常用的PHP类库, 资源以及技巧. 以便在工作中迅速的查找所需...
学习资源 PHP相关的有参考价值的社区,博客,网站,文章,书籍,视频等资源 PHP网站(PHP Websites) PHP The Right Way - 一个PHP实践的快速参考指导 PHP Bes ...
- 必学PHP类库/常用PHP类库大全
[JingwenTian]awesome-php [ziadoz]awesome-php 依赖管理( Dependency Management ) 用于依赖管理的包和框架 Composer / Pa ...
最新文章
- 苏联最早批量生产的晶体三极管
- python求众数程序_python求众数问题实例
- java课程设计总结迷宫_Java课程设计走迷宫详解.doc
- PaddlePaddle训练营——公开课——AI核心技术掌握——第2章机器能“看”的现代技术
- python-爬虫(1)
- html5 canvas移动位置,HTML5 Canvas 移动
- 手工扒网页模板简单流程
- swfupload 实例 php,SWFUpload在PHP中使用实例教程
- JavaWeb - 国家语言代码表
- 用css 添加手状样式,鼠标移上去变小手
- 关于canvas修改模式
- 【基础系列】赏析刘洪普《PyTorch深度学习实践》与《实战:基于CNN的MNIST手写数字识别》(Python版)
- vue3---dayjs-入门及常用方法
- Already included file name
- 工业过程控制领域中通信
- ES6——对yield和yield*的理解
- <2021SC@SDUSC>博客(9)山东大学软件工程应用与实践Jpress代码分析(8)
- 从恶意程序对LNK格式的利用方法看防护趋势
- P3084 照片 [差分约束]
- 柔性电子: 无铅的分子铁电体 TMBM-MnBr3