优化 Laravel 日志：解决 Monolog 链式异常堆栈跟踪不完整问题

优化 Laravel 日志：解决 Monolog 链式异常堆栈跟踪不完整问题

本文探讨了 laravel 6.x 中 monolog 1.x 在处理链式异常时，日志输出仅包含末端异常堆栈跟踪的局限性。针对这一痛点，教程提供了两种解决方案：推荐升级 monolog 至 2.x 版本，该版本已修复此问题；若无法升级，则可选择使用其他 monolog 格式化器或自定义格式化器来确保日志完整记录所有链式异常的堆栈信息，从而提升调试效率。

理解链式异常与 Monolog 的默认行为

在复杂的应用程序中，异常常常被捕获并重新抛出，同时附加原始异常作为“前一个异常”（previous exception），形成一个异常链。这种机制允许开发者在异常传播过程中添加更多上下文信息，同时保留原始错误的原因。例如：

<?php
// 应用入口点，调用业务逻辑
method1();
function method1()
{
try {
method2();
} catch (\Exception $e) {
// 在 Laravel Monolog 1.x 中，日志通常仅输出此异常的堆栈跟踪
throw new \Exception('调用 method1 失败，原因：' . $e->getMessage(), $e->getCode(), $e);
}
}
function method2()
{
try {
method3();
} catch (\Exception $e) {
throw new \Exception('调用 method2 失败，原因：' . $e->getMessage(), $e->getCode(), $e);
}
}
function method3()
{
// 这是原始异常，我们期望在日志中看到它的完整堆栈跟踪
throw new \Exception('哎呀，内部服务出错了！');
}

在上述示例中，method3 抛出原始异常，method2 捕获并将其包装后重新抛出，method1 再次捕获并包装。最终，Laravel 的 Monolog 日志系统（特别是当使用 LineFormatter 时）往往只会记录最外层异常（即 method1 中抛出的异常）的堆栈跟踪。这意味着，原始错误发生的位置和上下文信息（即 method3 的堆栈跟踪）被隐藏，这极大地增加了问题排查的难度。尽管 Monolog 会记录所有异常的消息，但缺乏完整的堆栈跟踪使得追溯根源变得困难。

解决方案一：升级 Monolog 至 2.x 版本（推荐）

Monolog 1.x 版本中的 LineFormatter 确实存在无法完整处理链式异常堆栈的问题。这个问题在 Monolog 2.x 版本中已经通过相关 Pull Request (例如 https://www.php.cn/link/fd2c18a27361dd16124f2780015b05f3) 得到了解决。值得注意的是，Laravel 6.x 及其更高版本是兼容 Monolog 2.x 的，因此，最直接且推荐的解决方案是升级 Monolog 库。

升级步骤：

在项目的根目录下，通过 Composer 更新 Monolog 依赖：

composer require monolog/monolog:^2.0
composer update

执行此命令后，Composer 将会下载并安装 Monolog 2.x 版本及其兼容的依赖