PHP日志库 - Monolog 知识整理

本文链接：https://blog.csdn.net/qq_35453862/article/details/125899153

一、基本信息

1.1 基本介绍

想必你已经从其它地方得知了 Monolog。没关系，我再说一次吧，手动狗头。

Monolog 是 PHP 比较全又很容易扩展的记录日志库。

Monolog 可以把日志发送到文件、邮箱、数据库、sockets 和各种 web services。

1.2 相关网址

GitHub - Monolog

Packagist - Monolog

1.3 日志等级

如果还没安装 Monolog , 请看下方安装流程。

在 /vendor/monolog/monolog/src/Monolog/Logger.php 文件中，可以看到已定义的 日志等级的类常量 与 受保护的静态成员属性 $levels。这是根据 RFC5424 描述，定义的 8 个日志级别。
# 日志级别常量, 从上至下 等级严重性 越来越高

DEBUG = 100; # 调试级别

INFO = 200; # 信息级别

NOTICE = 250; # 正常提示级别

WARNING = 300; # 警告级别

ERROR = 400; # 错误级别

CRITICAL = 500; # 严重级别

ALERT = 550; # 警报级别

EMERGENCY = 600; # 紧急情况

二、composer 安装 Monolog

如果还未安装 composer , 请先安装 Composer。

点我查看 - Mac M1 安装 Composer

点我查看 - 官方安装 Composer 流程

2.1 安装

# composer 安装 monolog, 确定好自己 PHP 的版本

# 我这里安装的是 monolog V2.7.0
composer require monolog/monolog

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.

解决方法:

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

三、基本用法介绍

接下来的内容，结合 3.4 实例代码 并手动操作理解会更加深刻。

3.1 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);

3.2 Handler

Handler 就是采用哪种方式对日志进行保存。

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

Handler 是采用堆栈方式保存, 所以是先入的 handler 后调用。

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

<?php
    use Monolog\Handler\ErrorLogHandler;
    
    $error_log_handler = new ErrorLogHandler();
    $error_log_handler->setFormatter($line_formatter); # 定义日志内容
    $log->pushHandler($error_log_handler); # 入栈

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

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

3. 将日志写入本地文件

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

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

<?php
    use Monolog\Handler\RotatingFileHandler;

	# 将日志写入本地文件, 默认自动按 天 生成日志文件
    $rotating_file_handler = new RotatingFileHandler("./log/day_register.log");
    $rotating_file_handler->setFormatter($json_formatter); # 定义日志内容
    $log->pushHandler($rotating_file_handler); # 入栈

3.3 Processor

Processor 就是增加额外的日志内容。

1. 自定义额外日志内容

<?php
    
    # 通过 $record['extra'] 返回
    $log->pushProcessor(function($record){
        $record['extra']['age'] = 18;
        $record['extra']['sex'] = '男';
        return $record;
    });

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

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

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

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

4. 生成 UID 唯一标识符

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

5. Git 相关

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

6. 主机名

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

7. 内存峰值使用率

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

8. 当前内存使用情况

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

9. 进程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":"男"}