Laravel 13.x 中文文档

主题

日志 ​

简介 ​

为了帮助您了解应用程序内部发生的情况，Laravel 提供了强大的日志服务，允许您将消息记录到文件、系统错误日志，甚至 Slack 以通知您的整个团队。

Laravel 日志基于"通道"。每个通道代表一种特定的日志信息写入方式。例如，single 通道将日志文件写入单个日志文件，而 slack 通道将日志消息发送到 Slack。日志消息可以根据其严重程度写入多个通道。

在底层，Laravel 使用 Monolog 库，它提供了对各种强大日志处理程序的支持。Laravel 使配置这些处理程序变得轻而易举，允许您混合和匹配它们以自定义应用程序的日志处理。

配置 ​

控制应用程序日志行为的所有配置选项都位于 config/logging.php 配置文件中。此文件允许您配置应用程序的日志通道，因此请务必查看每个可用通道及其选项。我们将在下面回顾几个常见选项。

默认情况下，Laravel 在记录消息时将使用 stack 通道。stack 通道用于将多个日志通道聚合到单个通道中。有关构建堆栈的更多信息，请查看下面的文档。

可用的通道驱动 ​

每个日志通道由"驱动"驱动。驱动确定日志消息实际记录的方式和位置。以下日志通道驱动在每个 Laravel 应用程序中都可用。大多数这些驱动的条目已经存在于您应用程序的 config/logging.php 配置文件中，因此请务必查看此文件以熟悉其内容：

名称描述
custom调用指定工厂创建通道的驱动。
daily基于 RotatingFileHandler 的 Monolog 驱动，每日轮转。
errorlog基于 ErrorLogHandler 的 Monolog 驱动。
monolog可以使用任何支持的 Monolog 处理程序的 Monolog 工厂驱动。
papertrail基于 SyslogUdpHandler 的 Monolog 驱动。
single单个文件或基于路径的日志通道 (StreamHandler)。
slack基于 SlackWebhookHandler 的 Monolog 驱动。
stack用于促进创建"多通道"通道的包装器。
syslog基于 SyslogHandler 的 Monolog 驱动。

NOTE

查看高级通道自定义文档以了解有关 monolog 和 custom 驱动的更多信息。

配置通道名称 ​

默认情况下，Monolog 使用与当前环境匹配的"通道名称"实例化，例如 production 或 local。要更改此值，您可以在通道配置中添加 name 选项：

php
'stack' => [
    'driver' => 'stack',
    'name' => 'channel-name',
    'channels' => ['single', 'slack'],
],

通道先决条件 ​

配置 Single 和 Daily 通道 ​

single 和 daily 通道有三个可选配置选项：bubble、permission 和 locking。

名称描述默认值
bubble指示消息在被处理后是否应冒泡到其他通道。true
locking尝试在写入日志文件之前锁定它。false
permission日志文件的权限。0644

此外，可以通过 LOG_DAILY_DAYS 环境变量或设置 days 配置选项来配置 daily 通道的保留策略。

名称描述默认值
days每日日志文件应保留的天数。14

配置 Papertrail 通道 ​

papertrail 通道需要 host 和 port 配置选项。这些可以通过 PAPERTRAIL_URL 和 PAPERTRAIL_PORT 环境变量定义。您可以从 Papertrail 获取这些值。

配置 Slack 通道 ​

slack 通道需要 url 配置选项。此值可以通过 LOG_SLACK_WEBHOOK_URL 环境变量定义。此 URL 应与您为 Slack 团队配置的传入 webhook 的 URL 匹配。

默认情况下，Slack 只会接收 critical 级别及以上的日志；但是，您可以使用 LOG_LEVEL 环境变量或修改 Slack 日志通道配置数组中的 level 配置选项来调整此设置。

记录弃用警告 ​

PHP、Laravel 和其他库经常通知其用户某些功能已被弃用，并将在未来版本中删除。如果您想记录这些弃用警告，可以使用 LOG_DEPRECATIONS_CHANNEL 环境变量或在应用程序的 config/logging.php 配置文件中指定您首选的 deprecations 日志通道：

php
'deprecations' => [
    'channel' => env('LOG_DEPRECATIONS_CHANNEL', 'null'),
    'trace' => env('LOG_DEPRECATIONS_TRACE', false),
],

'channels' => [
    // ...
]

或者，您可以定义一个名为 deprecations 的日志通道。如果存在具有此名称的日志通道，它将始终用于记录弃用：

php
'channels' => [
    'deprecations' => [
        'driver' => 'single',
        'path' => storage_path('logs/php-deprecation-warnings.log'),
    ],
],

构建日志堆栈 ​

如前所述，stack 驱动允许您将多个通道组合到单个日志通道中以方便使用。为了说明如何使用日志堆栈，让我们看一个您可能在生产应用程序中看到的示例配置：

php
'channels' => [
    'stack' => [
        'driver' => 'stack',
        'channels' => ['syslog', 'slack'], // [tl! add]
        'ignore_exceptions' => false,
    ],

    'syslog' => [
        'driver' => 'syslog',
        'level' => env('LOG_LEVEL', 'debug'),
        'facility' => env('LOG_SYSLOG_FACILITY', LOG_USER),
        'replace_placeholders' => true,
    ],

    'slack' => [
        'driver' => 'slack',
        'url' => env('LOG_SLACK_WEBHOOK_URL'),
        'username' => env('LOG_SLACK_USERNAME', 'Laravel Log'),
        'emoji' => env('LOG_SLACK_EMOJI', ':boom:'),
        'level' => env('LOG_LEVEL', 'critical'),
        'replace_placeholders' => true,
    ],
],

让我们分析这个配置。首先，注意我们的 stack 通道通过其 channels 选项聚合了另外两个通道：syslog 和 slack。因此，在记录消息时，这两个通道都有机会记录消息。但是，正如我们将在下面看到的，这些通道是否实际记录消息可能由消息的严重程度/"级别"决定。

日志级别 ​

请注意上面示例中 syslog 和 slack 通道配置中存在的 level 配置选项。此选项确定消息必须处于的最低"级别"才能被通道记录。Monolog 为 Laravel 的日志服务提供支持，提供 RFC 5424 规范中定义的所有日志级别。按严重程度降序排列，这些日志级别为：emergency、alert、critical、error、warning、notice、info 和 debug。

因此，假设我们使用 debug 方法记录消息：

php
Log::debug('An informational message.');

根据我们的配置，syslog 通道会将消息写入系统日志；但是，由于错误消息不是 critical 或更高级别，它不会被发送到 Slack。但是，如果我们记录 emergency 消息，它将被发送到系统日志和 Slack，因为 emergency 级别高于我们两个通道的最低级别阈值：

php
Log::emergency('The system is down!');

写入日志消息 ​

您可以使用 Log 门面将信息写入日志。如前所述，记录器提供 RFC 5424 规范中定义的八个日志级别：emergency、alert、critical、error、warning、notice、info 和 debug：

php
use Illuminate\Support\Facades\Log;

Log::emergency($message);
Log::alert($message);
Log::critical($message);
Log::error($message);
Log::warning($message);
Log::notice($message);
Log::info($message);
Log::debug($message);

您可以调用这些方法中的任何一个来记录相应级别的消息。默认情况下，消息将写入由您的 logging 配置文件配置的默认日志通道：

php
<?php

namespace App\Http\Controllers;

use App\Models\User;
use Illuminate\Support\Facades\Log;
use Illuminate\View\View;

class UserController extends Controller
{
    /**
     * 显示给定用户的个人资料。
     */
    public function show(string $id): View
    {
        Log::info('Showing the user profile for user: {id}', ['id' => $id]);

        return view('user.profile', [
            'user' => User::findOrFail($id)
        ]);
    }
}

上下文信息 ​

可以将上下文数据数组传递给日志方法。此上下文数据将被格式化并与日志消息一起显示：

php
use Illuminate\Support\Facades\Log;

Log::info('User {id} failed to login.', ['id' => $user->id]);

有时，您可能希望指定一些应包含在特定通道中所有后续日志条目中的上下文信息。例如，您可能希望记录与应用程序的每个传入请求关联的请求 ID。为此，您可以调用 Log 门面的 withContext 方法：

php
<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Str;
use Symfony\Component\HttpFoundation\Response;

class AssignRequestId
{
    /**
     * 处理传入请求。
     *
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
     */
    public function handle(Request $request, Closure $next): Response
    {
        $requestId = (string) Str::uuid();

        Log::withContext([
            'request-id' => $requestId
        ]);

        $response = $next($request);

        $response->headers->set('Request-Id', $requestId);

        return $response;
    }
}

如果您想在_所有_日志通道之间共享上下文信息，可以调用 Log::shareContext() 方法。此方法将向所有已创建的通道和随后创建的任何通道提供上下文信息：

php
<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Str;
use Symfony\Component\HttpFoundation\Response;

class AssignRequestId
{
    /**
     * 处理传入请求。
     *
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
     */
    public function handle(Request $request, Closure $next): Response
    {
        $requestId = (string) Str::uuid();

        Log::shareContext([
            'request-id' => $requestId
        ]);

        // ...
    }
}

NOTE

如果您需要在处理队列作业时共享日志上下文，可以使用作业中间件。

写入特定通道 ​

有时您可能希望将消息记录到应用程序默认通道以外的通道。您可以使用 Log 门面上的 channel 方法检索并记录到配置文件中定义的任何通道：

php
use Illuminate\Support\Facades\Log;

Log::channel('slack')->info('Something happened!');

如果您想创建一个由多个通道组成的按需日志堆栈，可以使用 stack 方法：

php
Log::stack(['single', 'slack'])->info('Something happened!');

按需通道 ​

也可以通过在运行时提供配置来创建按需通道，而该配置不存在于应用程序的 logging 配置文件中。为此，您可以将配置数组传递给 Log 门面的 build 方法：

php
use Illuminate\Support\Facades\Log;

Log::build([
  'driver' => 'single',
  'path' => storage_path('logs/custom.log'),
])->info('Something happened!');

您可能还希望在按需日志堆栈中包含按需通道。这可以通过将按需通道实例包含在传递给 stack 方法的数组中来实现：

php
use Illuminate\Support\Facades\Log;

$channel = Log::build([
  'driver' => 'single',
  'path' => storage_path('logs/custom.log'),
]);

Log::stack(['slack', $channel])->info('Something happened!');

Monolog 通道自定义 ​

为通道自定义 Monolog ​

有时您可能需要完全控制如何为现有通道配置 Monolog。例如，您可能希望为 Laravel 的内置 single 通道配置自定义 Monolog FormatterInterface 实现。

首先，在通道配置中定义一个 tap 数组。tap 数组应包含在创建 Monolog 实例后有机会自定义（或"切入"）该实例的类列表。没有约定这些类应该放在哪里，因此您可以自由地在应用程序中创建目录来包含这些类：

php
'single' => [
    'driver' => 'single',
    'tap' => [App\Logging\CustomizeFormatter::class],
    'path' => storage_path('logs/laravel.log'),
    'level' => env('LOG_LEVEL', 'debug'),
    'replace_placeholders' => true,
],

在通道上配置 tap 选项后，您就可以定义将自定义 Monolog 实例的类。此类只需要一个方法：__invoke，它接收 Illuminate\Log\Logger 实例。Illuminate\Log\Logger 实例将所有方法调用代理到底层 Monolog 实例：

php
<?php

namespace App\Logging;

use Illuminate\Log\Logger;
use Monolog\Formatter\LineFormatter;

class CustomizeFormatter
{
    /**
     * 自定义给定的记录器实例。
     */
    public function __invoke(Logger $logger): void
    {
        foreach ($logger->getHandlers() as $handler) {
            $handler->setFormatter(new LineFormatter(
                '[%datetime%] %channel%.%level_name%: %message% %context% %extra%'
            ));
        }
    }
}

NOTE

所有"tap"类都由服务容器解析，因此它们所需的任何构造函数依赖项都将自动注入。

创建 Monolog 处理程序通道 ​

Monolog 有多种可用的处理程序，Laravel 并不为每个处理程序包含内置通道。在某些情况下，您可能希望创建一个自定义通道，它仅仅是特定 Monolog 处理程序的实例，而该处理程序没有相应的 Laravel 日志驱动。可以使用 monolog 驱动轻松创建这些通道。

使用 monolog 驱动时，handler 配置选项用于指定将实例化哪个处理程序。可选地，可以使用 handler_with 配置选项指定处理程序所需的任何构造函数参数：

php
'logentries' => [
    'driver'  => 'monolog',
    'handler' => Monolog\Handler\SyslogUdpHandler::class,
    'handler_with' => [
        'host' => 'my.logentries.internal.datahubhost.company.com',
        'port' => '10000',
    ],
],

Monolog 格式化程序 ​

使用 monolog 驱动时，Monolog LineFormatter 将用作默认格式化程序。但是，您可以使用 formatter 和 formatter_with 配置选项自定义传递给处理程序的格式化程序类型：

php
'browser' => [
    'driver' => 'monolog',
    'handler' => Monolog\Handler\BrowserConsoleHandler::class,
    'formatter' => Monolog\Formatter\HtmlFormatter::class,
    'formatter_with' => [
        'dateFormat' => 'Y-m-d',
    ],
],

如果您使用的 Monolog 处理程序能够提供自己的格式化程序，可以将 formatter 配置选项的值设置为 default：

php
'newrelic' => [
    'driver' => 'monolog',
    'handler' => Monolog\Handler\NewRelicHandler::class,
    'formatter' => 'default',
],

Monolog 处理器 ​

Monolog 还可以在记录消息之前处理它们。您可以创建自己的处理器或使用 Monolog 提供的现有处理器。

如果您想为 monolog 驱动自定义处理器，请将 processors 配置值添加到通道配置中：

php
'memory' => [
    'driver' => 'monolog',
    'handler' => Monolog\Handler\StreamHandler::class,
    'handler_with' => [
        'stream' => 'php://stderr',
    ],
    'processors' => [
        // 简单语法...
        Monolog\Processor\MemoryUsageProcessor::class,

        // 带选项...
        [
            'processor' => Monolog\Processor\PsrLogMessageProcessor::class,
            'with' => ['removeUsedContextFields' => true],
        ],
    ],
],

通过工厂创建自定义通道 ​

如果您想定义一个完全自定义的通道，您可以在其中完全控制 Monolog 的实例化和配置，可以在配置文件中指定 custom 驱动类型。您的配置应包含一个 via 选项，该选项包含将被调用以创建 Monolog 实例的工厂类名称：

php
'channels' => [
    'custom' => [
        'driver' => 'custom',
        'via' => App\Logging\CreateCustomLogger::class,
    ],
],

一旦您配置了 custom 通道，您就可以定义将创建 Monolog 实例的类。此类只需要一个 __invoke 方法，该方法应返回 Monolog 记录器实例：

php
<?php

namespace App\Logging;

use Monolog\Logger;

class CreateCustomLogger
{
    /**
     * 创建自定义 Monolog 实例。
     */
    public function __invoke(array $config): Logger
    {
        return new Logger(/* ... */);
    }
}

使用 Pail 追踪日志消息 ​

通常您可能需要实时追踪应用程序的日志。例如，在调试问题或监视应用程序日志以查找特定类型的错误时。

Laravel Pail 是一个包，允许您直接从命令行轻松查看 Laravel 应用程序的日志文件。与标准 tail 命令不同，Pail 设计用于与任何日志驱动一起工作，包括 Sentry 或 Flare。此外，Pail 提供了一组有用的过滤器来帮助您快速找到所需内容。

安装 ​

WARNING

Laravel Pail 需要 PCNTL PHP 扩展。

首先，使用 Composer 包管理器将 Pail 安装到您的项目中：

shell
composer require --dev laravel/pail

使用 ​

要开始追踪日志，运行 pail 命令：

shell
php artisan pail

要增加输出的详细程度并避免截断（…），使用 -v 选项：

shell
php artisan pail -v

要获得最大详细程度并显示异常堆栈跟踪，使用 -vv 选项：

shell
php artisan pail -vv

要停止追踪日志，随时按 Ctrl+C。

过滤日志 ​

--filter ​

您可以使用 --filter 选项按类型、文件、消息和堆栈跟踪内容过滤日志：

shell
php artisan pail --filter="QueryException"

--message ​

要仅按消息过滤日志，可以使用 --message 选项：

shell
php artisan pail --message="User created"

--level ​

--level 选项可用于按日志级别过滤日志：

shell
php artisan pail --level=error

--user ​

要仅显示在给定用户经过身份验证时写入的日志，可以将用户 ID 提供给 --user 选项：

shell
php artisan pail --user=1