日志记录

• 简介
• 配置
  • 可用的通道驱动程序
  • 通道先决条件
  • 日志记录弃用警告
• 构建日志堆栈
• 编写日志消息
  • 上下文信息
  • 写入特定通道
• Monolog 通道自定义
  • 为通道自定义 Monolog
  • 创建 Monolog 处理程序通道
  • 通过工厂创建自定义通道
• 使用 Pail 尾随日志消息
  • 安装
  • 用法
  • 过滤日志

简介

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

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

在后台，Laravel 使用 Monolog 库，该库支持各种强大的日志处理程序。Laravel 使配置这些处理程序变得非常容易，允许您混合和匹配它们以自定义应用程序的日志处理。

配置

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

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

可用的通道驱动程序

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

配置通道名称

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

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

通道先决条件

配置 Single 和 Daily 通道

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

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

配置 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 日志通道

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

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

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

构建日志堆栈

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

'channels' => [
    'stack' => [
        'driver' => 'stack',
        'channels' => ['syslog', 'slack'], 
        '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 方法记录一条消息

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

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

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

编写日志消息

您可以使用Log 外观将信息写入日志。如前所述，日志记录器提供了在RFC 5424 规范中定义的八个日志记录级别：紧急、警报、严重错误、错误、警告、通知、信息和调试。

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
 
namespace App\Http\Controllers;
 
use App\Http\Controllers\Controller;
use App\Models\User;
use Illuminate\Support\Facades\Log;
use Illuminate\View\View;
 
class UserController extends Controller
{
    /**
     * Show the profile for the given user.
     */
    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)
        ]);
    }
}

上下文信息

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

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

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

<?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
{
    /**
     * Handle an incoming request.
     *
     * @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
 
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
{
    /**
     * Handle an incoming request.
     *
     * @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
        ]);
 
        // ...
    }
}

写入特定通道

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

use Illuminate\Support\Facades\Log;
 
Log::channel('slack')->info('Something happened!');

如果您希望创建一个由多个通道组成的按需日志记录堆栈，则可以使用stack方法。

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

按需通道

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

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

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

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 实例后对其进行自定义（或“拦截”）。这些类没有常规的位置，因此您可以自由地在应用程序中创建目录来包含这些类。

'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
 
namespace App\Logging;
 
use Illuminate\Log\Logger;
use Monolog\Formatter\LineFormatter;
 
class CustomizeFormatter
{
    /**
     * Customize the given logger instance.
     */
    public function __invoke(Logger $logger): void
    {
        foreach ($logger->getHandlers() as $handler) {
            $handler->setFormatter(new LineFormatter(
                '[%datetime%] %channel%.%level_name%: %message% %context% %extra%'
            ));
        }
    }
}

创建 Monolog 处理程序通道

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

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

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

Monolog 格式化程序

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

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

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

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

Monolog 处理器

Monolog 还可以处理消息，然后再记录它们。您可以创建自己的处理器或使用Monolog 提供的现有处理器。

如果您想自定义monolog驱动程序的处理器，请向通道的配置中添加processors配置值。

'memory' => [
    'driver' => 'monolog',
    'handler' => Monolog\Handler\StreamHandler::class,
    'with' => [
        'stream' => 'php://stderr',
    ],
    'processors' => [
        // Simple syntax...
        Monolog\Processor\MemoryUsageProcessor::class,
 
        // With options...
        [
           'processor' => Monolog\Processor\PsrLogMessageProcessor::class,
           'with' => ['removeUsedContextFields' => true],
       ],
    ],
],

通过工厂创建自定义通道

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

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

配置完custom驱动程序通道后，您就可以定义创建 Monolog 实例的类了。此类只需要一个__invoke方法，该方法应返回 Monolog 日志记录器实例。该方法将接收通道配置数组作为其唯一参数。

<?php
 
namespace App\Logging;
 
use Monolog\Logger;
 
class CreateCustomLogger
{
    /**
     * Create a custom Monolog instance.
     */
    public function __invoke(array $config): Logger
    {
        return new Logger(/* ... */);
    }
}

使用 Pail 尾随日志消息

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

Laravel Pail 是一个软件包，允许您直接从命令行轻松深入了解 Laravel 应用程序的日志文件。与标准的tail命令不同，Pail 旨在与任何日志驱动程序一起使用，包括 Sentry 或 Flare。此外，Pail 提供了一组有用的过滤器，可帮助您快速找到所需内容。

安装

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

composer require laravel/pail

用法

要开始跟踪日志，请运行pail命令。

php artisan pail

要提高输出的详细程度并避免截断（…），请使用-v选项。

php artisan pail -v

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

php artisan pail -vv

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

过滤日志

--filter

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

php artisan pail --filter="QueryException"

--message

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

php artisan pail --message="User created"

--level

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

php artisan pail --level=error

--user

要仅显示在特定用户进行身份验证期间写入的日志，您可以将用户的 ID 提供给--user选项。

php artisan pail --user=1