解决 Laravel Monolog 无法完整输出链式异常堆栈追踪的问题

<?php

// 入口点
method1();

function method1()
{
    try {
        method2();
    } catch (\Exception $e) {
        // Laravel Monolog 1.x 默认会输出这个异常的堆栈追踪，
        // 但它通常不是我们最关心的原始错误点。
        throw new \Exception('调用 method1 失败，因为出现问题', $e->getCode(), $e);
    }
}

function method2()
{
    try {
        method3();
    } catch (\Exception $e) {
        throw new \Exception('调用 method2 失败，因为出现问题', $e->getCode(), $e);
    }
}

function method3()
{
    // 这是原始异常，我们希望在日志中看到它的堆栈追踪，
    // 或者更好的是，所有三个异常的合并堆栈追踪。
    throw new \Exception('糟糕，一个错误发生了！');
}

<?php

use Monolog\Formatter\HtmlFormatter; // 或者 JsonFormatter

return [
    // ... 其他日志配置

    'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => ['single'],
            'ignore_exceptions' => false,
        ],

        'single' => [
            'driver' => 'single',
            'path' => storage_path('logs/laravel.log'),
            'level' => 'debug',
            'days' => 14,
            'tap' => [App\Logging\CustomizeFormatter::class], // 如果使用自定义格式化器
            // 'formatter' => HtmlFormatter::class, // 或者直接在这里指定内置格式化器
            // 'formatter_with' => [ // 如果格式化器需要构造参数
            //     'dateFormat' => 'Y-m-d H:i:s.u',
            //     'includeStacktraces' => true,
            // ],
        ],

        // ... 其他通道
    ],

    // ...
];

<?php

namespace App\Logging;

use Monolog\Formatter\LineFormatter;
use Throwable;

class CustomLineFormatter extends LineFormatter
{
    /**
     * 重写 format 方法以处理链式异常的堆栈追踪。
     * 这是一个简化的示例，实际实现可能需要更复杂的逻辑来格式化所有堆栈。
     */
    public function format(array $record): string
    {
        $output = parent::format($record);

        // 检查是否有异常并且是链式异常
        if (isset($record['context']['exception']) && $record['context']['exception'] instanceof Throwable) {
            $exception = $record['context']['exception'];
            $fullTrace = '';

            // 遍历所有链式异常，收集它们的堆栈信息
            do {
                $fullTrace .= $this->formatException($exception);
                $exception = $exception->getPrevious();
            } while ($exception);

            // 将完整的堆栈信息添加到输出中
            // 你需要根据你的需求调整输出格式
            $output .= "\n--- Full Exception Trace ---\n" . $fullTrace;
        }

        return $output;
    }

    /**
     * 格式化单个异常的堆栈信息。
     * 这个方法需要根据 Monolog 的内部逻辑来更精细地实现，
     * 以便与 LineFormatter 的默认输出保持一致或更优。
     */
    protected function formatException(Throwable $e): string
    {
        // 这是一个非常简化的示例，Monolog 内部有更复杂的异常格式化逻辑
        return sprintf(
            "%s: %s in %s:%s\nStack trace:\n%s\n",
            get_class($e),
            $e->getMessage(),
            $e->getFile(),
            $e->getLine(),
            $e->getTraceAsString()
        );
    }
}

<?php

return [
    // ...
    'channels' => [
        'single' => [
            'driver' => 'single',
            'path' => storage_path('logs/laravel.log'),
            'level' => 'debug',
            'formatter' => App\Logging\CustomLineFormatter::class, // 指定你的自定义格式化器
            'formatter_with' => [
                'dateFormat' => 'Y-m-d H:i:s.u',
                'includeStacktraces' => true, // 确保包含堆栈追踪
            ],
        ],
        // ...
    ],
];