PHP Monolog 日志的使用

最新推荐文章于 2024-08-10 07:06:36 发布
最新推荐文章于 2024-08-10 07:06:36 发布
阅读量1.5k 收藏 3
点赞数 2
分类专栏： php 文章标签： php 服务器 前端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_45178729/article/details/127694486
版权

前言

Monolog是php下比较全又容易扩展的记录日志类库。目前有包括Symfony 、Laravel、 CakePHP等诸多知名php框架都内置了Monolog。Monolog可以把你的日志发送到文件，sockets，收件箱，数据库和各种web services。

一、基本信息

1.1 基本介绍

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

1.2 核心概念

每一个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对日志记录添加内容。

1.3 相关网址

GitHub - Monolog

Packagist - Monolog

二、composer 安装 Monolog

composer require monolog/monolog

要求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');

2.2 报错处理

如果有以下报错, 请确认自己的PHP版本符合 Monolog 的PHP版本要求, 或者下载支持你当前 PHP 版本的 Monolog。

PHP Fatal error: Composer detected issues in your platform: Your Composer dependencies require a PHP version ">= 8.0.0". You are running 0.0.0.

解决方法:

  1. 在 composer.json 文件中的 config 模块添加 “platform-check”: false
"config": {
    "platform-check": false
},
"require": {
    "monolog/monolog": "^2.7.0"
}
  1. 执行 composer dump 命令

三、 日志等级

  • 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');
  1. 我们先创建一个Logger实例，传入的是频道名，这个频道名可以用于区分多个Logger实例。
  2. 实例本身并不知道如何处理日志记录，它是通过handler进行处理的。handler可以设置多个，例如上面的例子设置了两个handler，可以对日志记录进行两种不同方式的处理。
  3. 需要注意的是，由于handler是采用堆栈的方式保存，所以后面添加的handler位于栈顶，会首先被调用。

五、 Formatter 格式转换

Formatter 就是转化日志内容为需要的格式。

列举一些常用的 Formatter， 其它的请在 /vendor/monolog/monolog/src/Monolog/Formatter目录中查看。

1. 日志信息转化为 HTML 表格

<?php
    use Monolog\Formatter\HtmlFormatter;

	$dateFormat = "Y-m-d H:i:s"; # 自定义时间格式 - 可选
	
	# 将日志信息转化为 HTML 表格, 主要作用于邮件发送或生成日志历史页
	$html_formatter = new HtmlFormatter($dateFormat);

2. 日志信息转化为 JSON 格式

<?php
    use Monolog\Formatter\JsonFormatter;
	
	# 转化为 JSON 格式
	$json_formatter = new JsonFormatter();

3. 日志信息转化成一行字符串

默认格式: 在 /vendor/monolog/monolog/src/Monolog/Formatter/LineFormatter.php 文件中，可以看到已定义的默认的 日志格式。

public const SIMPLE_FORMAT = "[%datetime%] %channel%.%level_name%: %message% %context% %extra%\n";

<?php
    use Monolog\Formatter\LineFormatter;
	
	$dateFormat = "Y-m-d H:i:s"; # 自定义时间格式
	# 将日志数据转化为一行字符, 可自定义格式
    $output = "%datetime% > %level_name% > %channel% > %message% > %context% > %extra% \n "; # 自定义日志内容格式
    $line_formatter = new LineFormatter($output, $dateFormat);

六、Handler 日志保存

Handler 就是采用哪种方式对日志进行保存。
列举一些常用的 Handler， 其它的请在 /vendor/monolog/monolog/src/Monolog/Handler目录中查看。
Handler 是采用堆栈方式保存, 所以是先入的 handler 后调用。

1. 将日志信息写进 PHP 错误日志文件中

<?php
    use Monolog\Handler\ErrorLogHandler;
    use Monolog\Formatter\LineFormatter;

	$line_formatter = new LineFormatter();
    $error_log_handler = new ErrorLogHandler();
    $error_log_handler->setFormatter($line_formatter); # 定义日志内容
    $log->pushHandler($error_log_handler); # 入栈

2. 将日志信息通过邮件发送出去

<?php
    use Monolog\Handler\NativeMailerHandler;
    use Monolog\Formatter\HtmlFormatter;

	# 将日志信息转化为 HTML 表格, 主要作用于邮件发送或生成日志历史页
	$html_formatter = new HtmlFormatter();    

    # 将日志信息通过邮件发送出去
    $native_mailer_handler = new NativeMailerHandler("收件人邮箱", "邮件主题", "寄件人邮箱");
	$native_mailer_handler->setFormatter($html_formatter); # 定义日志内容
	$log->pushHandler($native_mailer_handler); # 入栈

3. 将日志写入本地文件

<?php
    use Monolog\Handler\StreamHandler;
    use Monolog\Formatter\LineFormatter;

	$line_formatter = new LineFormatter();
	# 将日志写入本地文件
	$stream_handler = new StreamHandler("./log/my_first_log.log");
    $stream_handler->setFormatter($line_formatter); # 定义日志内容
    $log->pushHandler($stream_handler); # 入栈

4. 将日志写入本地默认按 天 生成的文件

<?php
    use Monolog\Handler\RotatingFileHandler;
    use Monolog\Formatter\JsonFormatter;
	
	# 转化为 JSON 格式
	$json_formatter = new JsonFormatter();
	# 将日志写入本地文件, 默认自动按 天 生成日志文件
    $rotating_file_handler = new RotatingFileHandler("./log/day_register.log");
    $rotating_file_handler->setFormatter($json_formatter); # 定义日志内容
    $log->pushHandler($rotating_file_handler); # 入栈

七、Processor 添加额外的数据

  • 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方法进行绑定。

1. 脚本路径、行号、类名相关

<?php
    use Monolog\Processor\IntrospectionProcessor;
	
	# Processor - 额外保存 脚本路径、行号、类名 日志数据 - 可选
	$log->pushProcessor(new IntrospectionProcessor());

2. URI、IP、请求方式、请求域名、来源页

<?php
    use Monolog\Processor\WebProcessor;
	
	# Processor - 额外保存 UID 唯一标识符 日志数据 - 可选
	$log->pushProcessor(new WebProcessor());

3. 生成 UID 唯一标识符

<?php
    use Monolog\Processor\UidProcessor;
	
	# Processor - 额外保存 UID 唯一标识符 日志数据 - 可选
	$log->pushProcessor(new UidProcessor());

4. Git 相关

<?php
    use Monolog\Processor\GitProcessor;
	
	# Processor - 额外保存 Git 相关的日志数据 - 可选
	$log->pushProcessor(new GitProcessor());

5. 主机名

<?php
    use Monolog\Processor\HostnameProcessor;
	
	# Processor - 额外保存 主机名 日志数据 - 可选
	$log->pushProcessor(new HostnameProcessor());

6. 内存峰值使用率

<?php
    use Monolog\Processor\MemoryPeakUsageProcessor;
	
	# Logger - 额外保存 内存峰值使用率 日志数据 - 可选
	$log->pushProcessor(new MemoryPeakUsageProcessor());

7. 当前内存使用情况

<?php
    use Monolog\Processor\MemoryUsageProcessor;
	
	# Processor - 额外保存 当前内存使用情况 日志数据 - 可选
	$log->pushProcessor(new MemoryUsageProcessor());

8. 进程ID

<?php
    use Monolog\Processor\ProcessIdProcessor;
	
	# Processor - 额外保存 进程ID 日志数据 - 可选
	$log->pushProcessor(new ProcessIdProcessor());

八、实例代码

<?php
    
require('vendor/autoload.php');

use Monolog\Logger;

use Monolog\Formatter\HtmlFormatter;
use Monolog\Formatter\JsonFormatter;
use Monolog\Formatter\LineFormatter;

use Monolog\Handler\ErrorLogHandler;
use Monolog\Handler\NativeMailerHandler;
use Monolog\Handler\StreamHandler;
use Monolog\Handler\RotatingFileHandler;

use Monolog\Processor\IntrospectionProcessor;
use Monolog\Processor\WebProcessor;
use Monolog\Processor\UidProcessor;
use Monolog\Processor\GitProcessor;
use Monolog\Processor\HostnameProcessor;
use Monolog\Processor\MemoryPeakUsageProcessor;
use Monolog\Processor\MemoryUsageProcessor;
use Monolog\Processor\ProcessIdProcessor;

# 1. 创建日志服务
$log = new Logger("自定义的日志服务频道名称"); # 例: login_log

# 2. 自定义时区 - 可选, 默认采用 UTC 时间格式
$log->setTimezone(new DateTimeZone('Asia/Shanghai'));

# 3. 自定义时间格式 - 可选
$dateFormat = "Y-m-d H:i:s";

# 4. Formatter 部分 (根据功能需求, 选择一个合适的 Formatter)
    # 4.1 将日志信息转化为 HTML 表格, 主要作用于邮件发送或生成日志历史页
    $html_formatter = new HtmlFormatter($dateFormat);

    # 4.2 将日志数据转化为 JSON 格式
    $json_formatter = new JsonFormatter();

    # 4.3 将日志数据转化为一行字符, 可自定义格式
    $output = "%datetime% > %level_name% > %channel% > %message% > %context% > %extra% \n "; # 日志内容格式
    $line_formatter = new LineFormatter($output, $dateFormat);

# 5. Handler 部分 (根据功能需求, 选择一个合适的 Handler)
    # 5.1 将日志信息写信 PHP 错误日志文件中
    # $error_log_handler = new ErrorLogHandler();
    # $error_log_handler->setFormatter($line_formatter); # 定义日志内容
    # $log->pushHandler($error_log_handler); # 入栈

    # 5.2 将日志信息通过邮件发送出去
    # $native_mailer_handler = new NativeMailerHandler("收件人邮箱", "邮件主题", "寄件人邮箱");
    # $native_mailer_handler->setFormatter($html_formatter); # 定义日志内容
    # $log->pushHandler($native_mailer_handler); # 入栈

    # 5.3 将日志写入本地文件
    $stream_handler = new StreamHandler("日志文件绝对路径"); # 例: __DIR__ . /log/my_first_log.log
    $stream_handler->setFormatter($line_formatter); # 定义日志内容
    $log->pushHandler($stream_handler); # 入栈

    # 5.4 将日志写入本地文件, 默认自动按 天 生成的日志文件
    # $rotating_file_handler = new RotatingFileHandler("日志文件绝对路径"); # 例: __DIR__ . /log/my_first_log.log
    # $rotating_file_handler->setFormatter($json_formatter); # 定义日志内容
    # $log->pushHandler($rotating_file_handler); # 入栈

# 6. Processor 部分 (根据功能需求，可选多个 Processor)

    # 自定义额外数据
    $log->pushProcessor(function($record){
        $record['extra']['age'] = 18;
        $record['extra']['sex'] = '男';
        return $record;
    });
    $log->pushProcessor(new IntrospectionProcessor());
    # $log->pushProcessor(new WebProcessor());
    # $log->pushProcessor(new UidProcessor());
    # $log->pushProcessor(new GitProcessor());
    # $log->pushProcessor(new HostnameProcessor());
    # $log->pushProcessor(new MemoryPeakUsageProcessor());
    # $log->pushProcessor(new MemoryUsageProcessor());
    # $log->pushProcessor(new ProcessIdProcessor());

# 7. 将记录添加到日志, 根据自身需要, 选择一个日志等级进行记录
    $log->log("日志等级常量或日志等级数字", "日志消息", "日志内容");
    # 例： $log->log(200, '注册用户:', ['username'=>'Chon', 'height'=>175]);
    # $log->debug('Message');
    # $log->info('Message');
    # $log->notice('Message);
    # $log->warning('Message');
    # $log->error('Message);
    # $log->critical('Message');
    # $log->alert('Message');
    # $log->emergency('Message');

# 8. 保存日志的示例
	# 2022-07-20 15:31:32 > INFO > my_first_log > 注册用户: > {"username":"Chon","height":175} > {"age":18,"sex":"男"}

九、laravel举例封装

<?php
namespace App\Core;


use Monolog\Formatter\LineFormatter;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;

class BaseLog
{
    public static function info($type, $msg)
    {
        $log = new Logger('AIG');
        $type =  str_replace(".","/",$type);
        $handle = new StreamHandler(storage_path('logs/' . $type . '/' . date('Y-m-d', time()) . '/' . date('H', time()) . '.log'), Logger::DEBUG);
        $handle->setFormatter(new LineFormatter(null, null, true, true));
        $log->pushHandler($handle);
        $log->info($msg);
    }

    public static function error($type, $msg)
    {
        $log = new Logger('AIG');
        $type =  str_replace(".","/",$type);
        $handle = new StreamHandler(storage_path('logs/' . $type . '/' . date('Y-m-d', time()) . '/' . date('H', time()) . '-error.log'), Logger::DEBUG);
        $handle->setFormatter(new LineFormatter(null, null, true, true));
        $log->pushHandler($handle);
        $log->error($msg);
    }
}
荷逸同学
关注
专栏目录
Laravel基于PHP Monolog打造一个API日志记录器
pianzhou2021的博客
01-11 375
之前的文章中，我们提到了基于PHP Monolog打造一个API日志记录器，链接在此，基于PHP Monolog，打造一个API请求日志记录器 而本文中，我们将介绍如何在Laravel简洁快速的使用它。
基于PHP Monolog，打造数据库日志记录器(DatabaseHandler)
pianzhou2021的博客
01-11 612
基于Monolog打造数据库日志记录器
Laravel开发-correlate-php-monolog
08-28
Laravel开发-correlate-php-monolog 用于微服务将相关ID附加到日志消息的Monolog处理器。
Monolog-PHP日志类库
LanceLive
12-29 8359
Monolog是php下比较全又容易扩展的记录日志类库。目前有包括Symfony 、Laravel、 CakePHP等诸多知名php框架都内置了Monolog。Monolog可以把你的日志发送到文件，sockets，收件箱，数据库和各种web services。 Monolog遵循PSR3的接口规范，可以很轻易的替换成其他遵循同一规范的日志类库。Monolog具有良好的扩展性，通过Handl
Monolog 开源项目教程
最新发布
gitblog_00601的博客
08-10 386
Monolog 开源项目教程 monologSeldaek/monolog: Monolog是一个PHP的日志记录库，提供灵活的日志记录解决方案，支持多种日志处理器（如文件、邮件、错误日志、FirePHP、ChromePHP、Syslog等），并且具有可扩展性，方便开发者根据需求定制日志输出格式和存储方式。项目地址:https://gitcode.com/gh_mirrors/mo/monolo...
php日志,monolog - PHP 日志神器
weixin_30798867的博客
03-10 381
monolog - PHP 日志神器monolog - PHP 日志神器Monolog 发送你的日志到文件、到sockets、到邮箱、到数据库或(和)者其他网路存储服务(云)。这里用了或与和，因为Monolog的确可以做到同时保存到一个或多个存储介质。#### 安装$ composer require monolog/monolog#### 基本用法 (初步印象)use Monolog\Logge...
Monolog：PHP 日志记录工具
hjxisking的专栏
05-04 580
Monolog：PHP 日志记录工具 0 Monolog是php下比较全又容易扩展的记录日志组件。目前有包括Symfony 、Laravel、 CakePHP等诸多知名php框架都内置了Monolog。 Monolog可以把你的日志发送到文件，sockets，收件箱，数据库和各种web服务器上。一些特殊的组件可以给你带来特殊的日志策略。 使用例子
php monolog 使用,php – 使用Monolog记录整个数组
weixin_42300317的博客
03-22 261
如果检查记录器接口(https://github.com/php-fig/log/blob/master/Psr/Log/LoggerInterface.php),您将看到所有记录方法都以字符串形式显示消息,因此当您尝试使用字符串以外的变量类型进行记录时会收到警告.我尝试使用处理器以自定义方式格式化阵列,但正如预期的那样,在将变量发送到logger接口后会触发处理器.记录数组的最脏的方法可能是您选...
PHP自定义业务日志(monolog源码学习)
dobat的博客
08-07 4954
聊聊自己从开始工作到如今，对日志的认识。 在离校实习前，也多多少少做过一些自个玩的项目，后台管理系统、公众号都有整过，对所谓的日志没有什么概念，需要做什么记录都是操作数据库的自定义log表。 开始实习后，慢慢有接触到一些所谓日志的概念，最先接触的是ThinkPHP3.1的框架，不过有使用到的都是自定义打印日志，对想要记录的数组写入到自定义日志文件里。比如每次想要打印数据，调用一个公共函数，依赖...
monolog-telegram-handler：通过Telegram发送日志的Monolog处理程序
02-05
如果需要使用\Mero\Monolog\Formatter\HtmlFormatter添加symfony/yaml依赖项。 声明处理程序对象 要声明此处理程序，您需要知道该日志将被发送到的机器人令牌和聊天标识符（chat_id）。 // ... $ handler = new \ ...
php日志使用monolog
xieye114的专栏
06-14 541
首先安装composer composer.json [code="java"] { "require": { "monolog/monolog":"1.22.1" } } [/code] 说明，monolog对php版本要求很低。 代码 [code="java"] ...
php日志写什么内容,Monolog-PHP日志类库介绍
weixin_36118049的博客
03-09 241
Monolog遵循PSR3的接口规范，可以很轻易的替换成其他遵循同一规范的日志类库。Monolog具有良好的扩展性，通过Handler、Formatter和Processor这几个接口，可以对Monolog类库进行各种扩展和自定义。基本用法可以通过github或者composer安装Monolog，以下是使用composer安装最新版本：composer require monolog/monol...
php monolog 使用,PHP 依赖工具 monolog的使用
weixin_33512578的博客
03-22 199
require ‘vendor/autoload.php‘; //自动加载类库use Monolog\Logger;use Monolog\Handler\StreamHandler;// create a log channel$log = new Logger(‘SQL‘);$date = date(‘Y-m-d‘);//‘app/logs/sql_‘.$date.‘.log‘ 路径以及日志...
php monolog 使用,使用Monolog做日志
weixin_29322049的博客
03-22 685
Symfony自带了一个外部库 - 叫做 Monolog - 它允许你创建“可以存放在各种不同地方”的日志。记录一条信息¶要记录一条信息，从控制器中的容器取出 logger 服务:12345678910111213public function indexAction(){$logger = $this->get('logger');$logger->info('I just got...
monolog php,Monolog：PHP 日志记录工具
weixin_33438741的博客
03-12 253
Monolog是php下比较全又容易扩展的记录日志组件。目前有包括Symfony 、Laravel、 CakePHP等诸多知名php框架都内置了Monolog。 Monolog可以把你的日志发送到文件，sockets，收件箱，数据库和各种web服务器上。一些特殊的组件可以给你带来特殊的日志策略。 使Monolog是php下比较全又容易扩展的记录日志组件。目前有包括Symfony 、Laravel、...
PHP 依赖工具 monolog的使用
weixin_30731305的博客
06-02 116
<?phprequire 'vendor/autoload.php'; //自动加载类库use Monolog\Logger;use Monolog\Handler\StreamHandler;// create a log channel$log = new Logger('SQL');$date = date('Y-m-d'); //'app/logs/sql_'.$date.'.lo...
php日志库—monolog
SEUNRain的博客
11-16 1068
日志无论是在开发过程成中还是部署在生产环境中，都经常使用。我们平时使用日志是简单的使用file_put_contents将日志写入文件中，会显得很混乱，monolog可能是php中最好的日志系统。 下面是monolog的简单使用，后期强大的功能还有待发掘。 monolog概述 monolog是php下的组件，可以把日志发送到文件，邮箱，数据库，服务器上面。 安装： 环境：composer 在项目的根目录，编辑composer.json文件 { "require": { "monolog/monolog"..
PHP日志库 - Monolog 知识整理
Chon.Wang
07-20 1343
Monolog 整理
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

荷逸同学

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值