Laravel日志格式怎么改_Laravel日志自定义【详解】

夏辰君_2890

夏辰君_2890

2026-05-19

717人浏览

原创

laravel默认日志为彩色文本,对接elk等需json格式;改config/logging.php的'formatter'无效,因laravel不透传该配置,必须通过tap闭包替换monolog handler并注入jsonformatter。

laravel日志格式怎么改_laravel日志自定义【详解】

默认的 Laravel 日志是带颜色、换行、可读性强的文本格式,但对接 ELK、Loki、Datadog 等平台时,必须输出结构化 JSON —— 文本日志会被解析失败、字段丢失、时间戳无法对齐。改 formatter 配置项没用,Laravel 会忽略它;真正生效的是替换 Monolog 的 Handler。

为什么 config/logging.php 里改 'formatter' 不生效

Laravel 在初始化 channel 时,并不会把 formatter 配置透传给 Monolog 的 StreamHandler 或 DailyRotatingFileHandler。它只在极少数内置 handler(如 syslog)中读取该键,其余情况直接丢弃。你改了 'formatter' => \Monolog\Formatter\JsonFormatter::class,日志照样是文本。

必须通过 tap 闭包显式构造带 JsonFormatter 的 handler 实例。

  • tap 是唯一被 Laravel 日志系统尊重的“注入点”,用于接管 handler 构建过程
  • 所有自定义 formatter(包括时区、JSON 选项、上下文扁平化)都得在这里做
  • 别在 stack 通道上配 tap——它不转发到子通道,得配在具体驱动(如 daily)上

怎么用 tap + JsonFormatter 输出标准 JSON 日志

在 config/logging.php 的某个具体通道(比如叫 json_daily)里加 tap 数组,指向一个可调用类:

'json_daily' => [
    'driver' => 'daily',
    'path' => storage_path('logs/json/app.log'),
    'level' => 'debug',
    'days' => 14,
    'tap' => [App\Logging\CustomJsonLogger::class],
],

然后新建 app/Logging/CustomJsonLogger.php:

Laravel Creem Agent
Laravel Creem Agent

Creem 支付商店助理 — 查询订阅、客户、交易、产品,执行心跳检查,管理本地 Laravel支付商店。

下载
namespace App\Logging;

use Monolog\Handler\StreamHandler;
use Monolog\Formatter\JsonFormatter;
use Illuminate\Support\Facades\Log;

class CustomJsonLogger
{
    public function __invoke($logger)
    {
        foreach ($logger->getHandlers() as $handler) {
            if (method_exists($handler, 'setFormatter')) {
                $formatter = new JsonFormatter(
                    JsonFormatter::BATCH_MODE_JSON, 
                    new \DateTimeZone('Asia/Shanghai')
                );
                $formatter->includeStacktraces(false);
                $handler->setFormatter($formatter);
            }
        }
    }
}
  • JsonFormatter::BATCH_MODE_JSON 确保每条日志一行,避免换行符破坏 JSON 流解析
  • 必须传 \DateTimeZone 实例,否则 datetime 字段是 UTC 时间戳(秒级),不是 ISO8601 字符串
  • 不要依赖 JsonFormatter::SIMPLE——它不支持时区,且默认含 extra 和 context 嵌套,ELK 不友好

Log::info() 传数组自动 JSON 化,但 context 仍被嵌套

你写 Log::channel('json_daily')->info('User logged in', ['user_id' => 123, 'ip' => '1.2.3.4']),JsonFormatter 默认会把第二个参数塞进 context 字段,结果是:

{"message":"User logged in","context":{"user_id":123,"ip":"1.2.3.4"},...}

而多数日志平台希望这些字段平铺在根层级。要扁平化,得重写 format 方法或用 Processor:

  • 在 CustomJsonLogger 的 __invoke 中,给 handler 加 processor:$handler->pushProcessor(function ($record) { return array_merge($record, $record['context'] ?? []); });
  • 注意:这会覆盖同名字段(如 message),需手动排除 context 和 extra
  • 更稳妥的做法是继承 JsonFormatter,重写 format,把 context 键值合并进顶层

环境变量控制是否启用 JSON 格式

开发时想看文本,生产才用 JSON?别写两套配置。在 tap 类里判断环境:

if (app()->environment('production')) {
    $handler->setFormatter(new JsonFormatter(...));
}

或者更灵活地用 .env 控制:

  • 加 LOG_JSON_FORMAT=true 到 .env
  • 在 CustomJsonLogger 里用 env('LOG_JSON_FORMAT') === 'true' 做开关
  • 注意:别用 config() 读取,此时 config 尚未完全加载,应直接读 env()

JSON 日志真正的复杂点不在“怎么输出”,而在“字段要不要扁平化”“时区要不要强制覆盖”“context 里敏感字段要不要过滤”——这些没法靠一个配置开关解决,必须在 tap 或自定义 Formatter 里逐层控制。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

laravel

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

837

10

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

2024.04.09

835

9

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2024.04.09

2468

10

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.10

3801

7

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

2025.08.05

5370

22

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

2025.08.05

3596

13

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

2025.08.05

6769

7

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

2026.03.04

1396

29

Laravel 框架安装指南
Laravel 框架安装指南

本指南详解 Laravel 框架安装全流程,涵盖 PHP 8.1+ 环境配置、Composer 依赖管理工具安装及国内镜像源优化。重点演示使用 composer create-project 命令创建 Laravel 10/11 项目,解决常见安装错误与依赖冲突。从环境搭建到项目初始化,助您快速完成 Laravel 开发环境部署,为后续 Web 应用开发奠定基础。适合 PHP 初学者与框架迁移开发者参考。

2026.04.09

195

6

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 201人学习

Composer手册
Composer手册

共0课时 | 0人学习