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

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:增加内存使用高峰时的信息。

时间: 2024-09-19 09:26:26

Monolog PHP日志类库使用详解介绍的相关文章

MySQL慢查询日志开启分析详解介绍

(1)配置开启 Linux: 在mysql配置文件 my.cnf 中增加如下语句: log-slow-queries=/var/lib/mysql/slowquery.log #指定日志文件存放位置,可以为空,系统会给一个缺省的文件host_name-slow.log long_query_time=5 #记录超过的时间,默认为10s,这里设置为查询时间超过5s的查询语句 log-queries-not-using-indexes = on # 列出没有使用索引的查询语句 #log-querie

Nginx实现浏览器可实时查看访问日志的步骤详解_nginx

一.首先查看nginx版本,我使用的是1.9.7的版本,安装目录在/application/nginx-1.9.7 [root@AnSheng ~]# /application/nginx-1.9.7/sbin/nginx -V nginx version: nginx/1.9.7 built by gcc 4.4.7 20120313 (Red Hat 4.4.7-16) (GCC) configure arguments: --prefix=/application/nginx-1.9.7

MBR和GPT分区表是什么,MBR和GPT分区表详解介绍

MBR和GPT分区表详解 全新硬盘(未初始化)装系统之前,必须对齐进行分区,硬盘分区初始化的格式包括MBR和GPT两种.当然对于基于PowerPC的Mac电脑还有专门的Apple分区图,在这里就不做介绍. MBR的全称是Master Boot Record(主引导记录),MBR早在1983年IBM PC DOS 2.0中就已经提出.之所以叫"主引导记录",是因为它是存在于驱动器开始部分的一个特殊的启动扇区.这个扇区包含了已安装的操作系统的启动加载器和驱动器的逻辑分区信息. 主引导扇区是

MySQL触发器的用途和用法详解介绍

触发器是一种特殊的存储过程,它在插入,删除或修改特定表中的数据时触发执行,它比数据库本身标准的功能有更精细和更复杂的数据控制能力.触发器的作用: 1. 安全性.可以基于数据库的值使用户具有操作数据库的某种权利: 可以基于时间限制用户的操作,例如不允许下班后和节假日修改数据库数据: 可以基于数据库中的数据限制用户的操作,例如不允许股票的价格的升幅一次超过10%. 2. 审计.可以跟踪用户对数据库的操作: 审计用户操作数据库的语句: 把用户对数据库的更新写入审计表. 3. 实现复杂的数据完整性规则:

Nginx 服务器安装及配置文件详解介绍_nginx

Nginx 在工作中已经有好几个环境在使用了,每次都是重新去网上找博客,各种编译配置,今天自己也整理一份安装文档和 nginx.conf 配置选项的说明,留作以后参考. 1. 安装nginx 1.1 选择稳定版本 我们编译安装nginx来定制自己的模块,机器CentOS 6.2 x86_64.首先安装缺少的依赖包: # yum -y install gcc gcc-c++ make libtool zlib zlib-devel openssl openssl-devel pcre pcre-d

Mysql分库分表Mycat详解介绍

一直对Mysql分库分表有点兴趣,但是也一直停留在有兴趣的阶段,没有遇到能应用的场景.人生苦短,与其等一个机会,不如自己创造吧.稍微调研了下,选择使用 Mycat 这样一款开源产品.没有什么特别的理由,也不去讨论挖掘机哪家强,只是为了学习. 本机环境 电脑环境:Ubuntu 16.04 JDK:1.8 Docker version 1.11.2 Mysql 5.7.13 Mycat 1.5-RELEASE Navicat for Mysql 安装Mysql 为了测试方便,Mysql都跑在Dock

MySQL分库分表的实现过程详解介绍

MySQL分库分表基础表介绍 表基本模型结构 这里我们模拟一个商城的基本的表结.此结构由(用户.门店.导购.门店商品.订单.订单对应的商品).其中,导购也是一个用户,门店是只属于一个店主的,同时店主本身也是一个导购也是一个普通用户. 结构图:   构造数据脚本 MySQL分库分表(1)-脚本 对业务场景进行模拟 场景1:购买者下订单. 1.从session中获得客户ID. 2.可以通过时间戳等拼凑一个订单ID(在创建表的时候为了方便我用自增的,在以下我们一直就吧订单ID看成不是自增的,是用程序生

使用Log4j为项目配置日志输出应用详解以及示例演示的实现分析_java

Log4j组件构成  Log4j由三个重要的组件构成: 1.日志信息的优先级(Logger) 2.日志信息的输出目的地(Appender) 3.日志信息的输出格式(Layout). 概要: 日志信息的优先级从高到低有ERROR.WARN. INFO.DEBUG,分别用来指定这条日志信息的重要程度: 日志信息的输出目的地指定了日志将打印到控制台还是文件中: 而输出格式则控制了日志信息的显示内容. Log4j介绍 Log4j是 Apache的一个开放源代码项目,通过使用Log4j,我们可以控制日志信

服务器托管的优势与功能详解介绍

中介交易 http://www.aliyun.com/zixun/aggregation/6858.html">SEO诊断 淘宝客 云主机 技术大厅 服务器托管是指为了提高网站的访问速度,将您的服务器及相关设备托管到具有完善机房设施.高品质网络环境.丰富带宽资源和运营经验以及可对用户的网络和设备进行实时监控的网络数据中心内,以此使系统达到安全.可靠.稳定.高效运行的目的. 当用户有意拥有自己的Web.Email. FTP. SQL等服务器时,可以有两种方法: 一是自建, 二是托管. 自建需