Skip to content
赞助商赞助商
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待

Laravel Pulse

介绍

Laravel Pulse 提供了对您应用程序性能和使用情况的快速洞察。使用 Pulse,您可以追踪瓶颈,例如慢作业和端点,找到您最活跃的用户等等。

要深入调试单个事件,请查看 Laravel Telescope

安装

WARNING

Pulse 的第一方存储实现目前需要 MySQL、MariaDB 或 PostgreSQL 数据库。如果您使用不同的数据库引擎,您将需要一个单独的 MySQL、MariaDB 或 PostgreSQL 数据库来存储 Pulse 数据。

您可以使用 Composer 包管理器安装 Pulse:

sh
composer require laravel/pulse

接下来,您应该使用 vendor:publish Artisan 命令发布 Pulse 配置和迁移文件:

shell
php artisan vendor:publish --provider="Laravel\Pulse\PulseServiceProvider"

最后,您应该运行 migrate 命令以创建存储 Pulse 数据所需的表:

shell
php artisan migrate

一旦 Pulse 的数据库迁移完成,您可以通过 /pulse 路由访问 Pulse 仪表板。

NOTE

如果您不想将 Pulse 数据存储在应用程序的主数据库中,您可以 指定一个专用数据库连接

配置

Pulse 的许多配置选项可以通过环境变量进行控制。要查看可用选项、注册新记录器或配置高级选项,您可以发布 config/pulse.php 配置文件:

sh
php artisan vendor:publish --tag=pulse-config

仪表板

授权

Pulse 仪表板可以通过 /pulse 路由访问。默认情况下,您只能在 local 环境中访问此仪表板,因此您需要通过自定义 'viewPulse' 授权网关为生产环境配置授权。您可以在应用程序的 app/Providers/AppServiceProvider.php 文件中完成此操作:

php
use App\Models\User;
use Illuminate\Support\Facades\Gate;

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    Gate::define('viewPulse', function (User $user) {
        return $user->isAdmin();
    });

    // ...
}

自定义

Pulse 仪表板的卡片和布局可以通过发布仪表板视图进行配置。仪表板视图将发布到 resources/views/vendor/pulse/dashboard.blade.php

sh
php artisan vendor:publish --tag=pulse-dashboard

仪表板由 Livewire 提供支持,允许您在不需要重建任何 JavaScript 资产的情况下自定义卡片和布局。

在此文件中,<x-pulse> 组件负责渲染仪表板,并为卡片提供网格布局。如果您希望仪表板跨越屏幕的全宽,您可以向组件提供 full-width 属性:

blade
<x-pulse full-width>
    ...
</x-pulse>

默认情况下,<x-pulse> 组件将创建一个 12 列网格,但您可以使用 cols 属性自定义此设置:

blade
<x-pulse cols="16">
    ...
</x-pulse>

每个卡片接受 colsrows 属性以控制空间和定位:

blade
<livewire:pulse.usage cols="4" rows="2" />

大多数卡片还接受 expand 属性,以显示完整卡片而不是滚动:

blade
<livewire:pulse.slow-queries expand />

解析用户

对于显示有关用户信息的卡片,例如应用程序使用情况卡,Pulse 只会记录用户的 ID。在渲染仪表板时,Pulse 将从您的默认 Authenticatable 模型解析 nameemail 字段,并使用 Gravatar 网络服务显示头像。

您可以通过在应用程序的 App\Providers\AppServiceProvider 类中调用 Pulse::user 方法来自定义字段和头像。

user 方法接受一个闭包,该闭包将接收要显示的 Authenticatable 模型,并应返回一个包含用户的 nameextraavatar 信息的数组:

php
use Laravel\Pulse\Facades\Pulse;

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    Pulse::user(fn ($user) => [
        'name' => $user->name,
        'extra' => $user->email,
        'avatar' => $user->avatar_url,
    ]);

    // ...
}

NOTE

您可以通过实现 Laravel\Pulse\Contracts\ResolvesUsers 合同并在 Laravel 的 服务容器 中绑定它,完全自定义如何捕获和检索经过身份验证的用户。

卡片

服务器

<livewire:pulse.servers /> 卡片显示运行 pulse:check 命令的所有服务器的系统资源使用情况。有关系统资源报告的更多信息,请参阅 服务器记录器 文档。

如果您在基础设施中替换了服务器,您可能希望在给定时间后停止在 Pulse 仪表板上显示不活动的服务器。您可以使用 ignore-after 属性来实现,该属性接受不活动服务器应从 Pulse 仪表板中删除的秒数。或者,您可以提供相对时间格式的字符串,例如 1 hour3 days and 1 hour

blade
<livewire:pulse.servers ignore-after="3 hours" />

应用程序使用情况

<livewire:pulse.usage /> 卡片显示向您的应用程序发出请求、调度作业和经历慢请求的前 10 个用户。

如果您希望同时在屏幕上查看所有使用情况指标,您可以多次包含该卡片并指定 type 属性:

blade
<livewire:pulse.usage type="requests" />
<livewire:pulse.usage type="slow_requests" />
<livewire:pulse.usage type="jobs" />

要了解如何自定义 Pulse 检索和显示用户信息,请查阅我们关于 解析用户 的文档。

NOTE

如果您的应用程序接收大量请求或调度大量作业,您可能希望启用 采样。有关更多信息,请参阅 用户请求记录器用户作业记录器慢作业记录器 文档。

异常

<livewire:pulse.exceptions /> 卡片显示您应用程序中发生的异常的频率和最近性。默认情况下,异常根据异常类和发生位置进行分组。有关更多信息,请参阅 异常记录器 文档。

队列

<livewire:pulse.queues /> 卡片显示您应用程序中队列的吞吐量,包括排队、处理、已处理、释放和失败的作业数量。有关更多信息,请参阅 队列记录器 文档。

慢请求

<livewire:pulse.slow-requests /> 卡片显示超过配置阈值的传入请求,默认值为 1,000ms。有关更多信息,请参阅 慢请求记录器 文档。

慢作业

<livewire:pulse.slow-jobs /> 卡片显示超过配置阈值的排队作业,默认值为 1,000ms。有关更多信息,请参阅 慢作业记录器 文档。

慢查询

<livewire:pulse.slow-queries /> 卡片显示超过配置阈值的数据库查询,默认值为 1,000ms。

默认情况下,慢查询根据 SQL 查询(不带绑定)和发生位置进行分组,但您可以选择不捕获位置,以便仅根据 SQL 查询进行分组。

如果您遇到由于极大的 SQL 查询接收语法高亮而导致的渲染性能问题,您可以通过添加 without-highlighting 属性来禁用高亮:

blade
<livewire:pulse.slow-queries without-highlighting />

有关更多信息,请参阅 慢查询记录器 文档。

慢外部请求

<livewire:pulse.slow-outgoing-requests /> 卡片显示使用 Laravel 的 HTTP 客户端 发出的超过配置阈值的外部请求,默认值为 1,000ms。

默认情况下,条目将按完整 URL 分组。但是,您可能希望使用正则表达式规范化或分组相似的外部请求。有关更多信息,请参阅 慢外部请求记录器 文档。

缓存

<livewire:pulse.cache /> 卡片显示您应用程序的缓存命中和未命中统计信息,包括全局和单个键的统计信息。

默认情况下,条目将按键分组。但是,您可能希望使用正则表达式规范化或分组相似的键。有关更多信息,请参阅 缓存交互记录器 文档。

捕获条目

大多数 Pulse 记录器将根据 Laravel 触发的框架事件自动捕获条目。然而,服务器记录器 和一些第三方卡片必须定期轮询信息。要使用这些卡片,您必须在所有单独的应用程序服务器上运行 pulse:check 守护进程:

php
php artisan pulse:check

NOTE

要使 pulse:check 进程永久在后台运行,您应该使用进程监视器,例如 Supervisor,以确保该命令不会停止运行。

由于 pulse:check 命令是一个长时间运行的进程,因此在代码库中进行更改时,它将无法看到这些更改。您应该通过在应用程序的部署过程中调用 pulse:restart 命令来优雅地重启该命令:

sh
php artisan pulse:restart

NOTE

Pulse 使用 缓存 来存储重启信号,因此在使用此功能之前,您应该验证您的应用程序是否正确配置了缓存驱动程序。

记录器

记录器负责捕获来自您的应用程序的条目,以便记录在 Pulse 数据库中。记录器在 Pulse 配置文件recorders 部分中注册和配置。

缓存交互

CacheInteractions 记录器捕获您应用程序中发生的 缓存 命中和未命中信息,以便在 缓存 卡片上显示。

您可以选择调整 采样率 和忽略的键模式。

您还可以配置键分组,以便将相似的键分组为单个条目。例如,您可能希望从缓存相同类型信息的键中删除唯一 ID。组通过正则表达式配置,以“查找和替换”键的部分。配置文件中包含示例:

php
Recorders\CacheInteractions::class => [
    // ...
    'groups' => [
        // '/:\d+/' => ':*',
    ],
],

第一个匹配的模式将被使用。如果没有模式匹配,则键将按原样捕获。

异常

Exceptions 记录器捕获您应用程序中发生的可报告异常的信息,以便在 异常 卡片上显示。

您可以选择调整 采样率 和忽略的异常模式。您还可以配置是否捕获异常来源的位置。捕获的位置将显示在 Pulse 仪表板上,这可以帮助追踪异常来源;但是,如果相同的异常在多个位置发生,则它将针对每个唯一位置多次出现。

队列

Queues 记录器捕获您应用程序的队列信息,以便在 队列 上显示。

您可以选择调整 采样率 和忽略的作业模式。

慢作业

SlowJobs 记录器捕获您应用程序中发生的慢作业的信息,以便在 慢作业 卡片上显示。

您可以选择调整慢作业阈值、采样率 和忽略的作业模式。

您可能有一些作业您期望花费比其他作业更长的时间。在这些情况下,您可以配置每个作业的阈值:

php
Recorders\SlowJobs::class => [
    // ...
    'threshold' => [
        '#^App\\Jobs\\GenerateYearlyReports$#' => 5000,
        'default' => env('PULSE_SLOW_JOBS_THRESHOLD', 1000),
    ],
],

如果没有正则表达式模式匹配作业的类名,则将使用 'default' 值。

慢外部请求

SlowOutgoingRequests 记录器捕获使用 Laravel 的 HTTP 客户端 发出的超过配置阈值的外部 HTTP 请求的信息,以便在 慢外部请求 卡片上显示。

您可以选择调整慢外部请求阈值、采样率 和忽略的 URL 模式。

您可能有一些外部请求您期望花费比其他请求更长的时间。在这些情况下,您可以配置每个请求的阈值:

php
Recorders\SlowOutgoingRequests::class => [
    // ...
    'threshold' => [
        '#backup.zip$#' => 5000,
        'default' => env('PULSE_SLOW_OUTGOING_REQUESTS_THRESHOLD', 1000),
    ],
],

如果没有正则表达式模式匹配请求的 URL,则将使用 'default' 值。

您还可以配置 URL 分组,以便将相似的 URL 分组为单个条目。例如,您可能希望从 URL 路径中删除唯一 ID 或仅按域进行分组。配置文件中包含一些示例:

php
Recorders\SlowOutgoingRequests::class => [
    // ...
    'groups' => [
        // '#^https://api\.github\.com/repos/.*$#' => 'api.github.com/repos/*',
        // '#^https?://([^/]*).*$#' => '\1',
        // '#/\d+#' => '/*',
    ],
],

第一个匹配的模式将被使用。如果没有模式匹配,则 URL 将按原样捕获。

慢查询

SlowQueries 记录器捕获您应用程序中超过配置阈值的任何数据库查询的信息,以便在 慢查询 卡片上显示。

您可以选择调整慢查询阈值、采样率 和忽略的查询模式。您还可以配置是否捕获查询位置。捕获的位置将显示在 Pulse 仪表板上,这可以帮助追踪查询来源;但是,如果相同的查询在多个位置发生,则它将针对每个唯一位置多次出现。

您可能有一些查询您期望花费比其他查询更长的时间。在这些情况下,您可以配置每个查询的阈值:

php
Recorders\SlowQueries::class => [
    // ...
    'threshold' => [
        '#^insert into `yearly_reports`#' => 5000,
        'default' => env('PULSE_SLOW_QUERIES_THRESHOLD', 1000),
    ],
],

如果没有正则表达式模式匹配查询的 SQL,则将使用 'default' 值。

慢请求

Requests 记录器捕获向您的应用程序发出的请求的信息,以便在 慢请求应用程序使用情况 卡片上显示。

您可以选择调整慢路由阈值、采样率 和忽略的路径。

您可能有一些请求您期望花费比其他请求更长的时间。在这些情况下,您可以配置每个请求的阈值:

php
Recorders\SlowRequests::class => [
    // ...
    'threshold' => [
        '#^/admin/#' => 5000,
        'default' => env('PULSE_SLOW_REQUESTS_THRESHOLD', 1000),
    ],
],

如果没有正则表达式模式匹配请求的 URL,则将使用 'default' 值。

服务器

Servers 记录器捕获为您的应用程序提供服务的服务器的 CPU、内存和存储使用情况的信息,以便在 服务器 卡片上显示。此记录器要求在您希望监控的每个服务器上运行 pulse:check 命令

每个报告服务器必须具有唯一名称。默认情况下,Pulse 将使用 PHP 的 gethostname 函数返回的值。如果您希望自定义此值,您可以设置 PULSE_SERVER_NAME 环境变量:

PULSE_SERVER_NAME=load-balancer

Pulse 配置文件还允许您自定义要监控的目录。

用户作业

UserJobs 记录器捕获在您的应用程序中调度作业的用户的信息,以便在 应用程序使用情况 卡片上显示。

您可以选择调整 采样率 和忽略的作业模式。

用户请求

UserRequests 记录器捕获向您的应用程序发出请求的用户的信息,以便在 应用程序使用情况 卡片上显示。

您可以选择调整 采样率 和忽略的 URL 模式。

过滤

正如我们所看到的,许多 记录器 提供了通过配置“忽略”传入条目的能力,基于其值,例如请求的 URL。但是,有时根据其他因素过滤记录可能会很有用,例如当前经过身份验证的用户。要过滤这些记录,您可以将闭包传递给 Pulse 的 filter 方法。通常,filter 方法应在应用程序的 AppServiceProviderboot 方法中调用:

php
use Illuminate\Support\Facades\Auth;
use Laravel\Pulse\Entry;
use Laravel\Pulse\Facades\Pulse;
use Laravel\Pulse\Value;

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    Pulse::filter(function (Entry|Value $entry) {
        return Auth::user()->isNotAdmin();
    });

    // ...
}

性能

Pulse 旨在无缝融入现有应用程序,而无需任何额外的基础设施。然而,对于高流量应用程序,有几种方法可以消除 Pulse 可能对应用程序性能的影响。

使用不同的数据库

对于高流量应用程序,您可能希望使用专用数据库连接来避免影响应用程序数据库。

您可以通过设置 PULSE_DB_CONNECTION 环境变量来自定义 Pulse 使用的 数据库连接

PULSE_DB_CONNECTION=pulse

Redis 导入

WARNING

Redis 导入需要 Redis 6.2 或更高版本以及 phpredispredis 作为应用程序配置的 Redis 客户端驱动程序。

默认情况下,Pulse 将在 HTTP 响应发送到客户端或作业处理后直接将条目存储到 配置的数据库连接 中;但是,您可以使用 Pulse 的 Redis 导入驱动程序将条目发送到 Redis 流中。通过配置 PULSE_INGEST_DRIVER 环境变量可以启用此功能:

PULSE_INGEST_DRIVER=redis

Pulse 将默认使用您的 Redis 连接,但您可以通过 PULSE_REDIS_CONNECTION 环境变量自定义此设置:

PULSE_REDIS_CONNECTION=pulse

使用 Redis 导入时,您需要运行 pulse:work 命令来监控流并将条目从 Redis 移动到 Pulse 的数据库表中。

php
php artisan pulse:work

NOTE

要使 pulse:work 进程永久在后台运行,您应该使用进程监视器,例如 Supervisor,以确保 Pulse 工作进程不会停止运行。

由于 pulse:work 命令是一个长时间运行的进程,因此在代码库中进行更改时,它将无法看到这些更改。您应该优雅地重启该命令,通过在应用程序的部署过程中调用 pulse:restart 命令:

sh
php artisan pulse:restart

NOTE

Pulse 使用 缓存 来存储重启信号,因此在使用此功能之前,您应该验证您的应用程序是否正确配置了缓存驱动程序。

采样

默认情况下,Pulse 将捕获应用程序中发生的每个相关事件。对于高流量应用程序,这可能导致在仪表板中需要聚合数百万行数据库,尤其是对于较长的时间段。

您可以选择在某些 Pulse 数据记录器上启用“采样”。例如,将 用户请求 记录器的采样率设置为 0.1 将意味着您只记录大约 10% 的请求。在仪表板中,值将被放大并以 ~ 前缀表示它们是近似值。

通常,对于特定指标,您拥有的条目越多,您可以安全地将采样率设置得越低,而不会牺牲太多准确性。

修剪

Pulse 将在条目超出仪表板窗口时自动修剪其存储的条目。修剪发生在使用可能在 Pulse 配置文件 中自定义的抽奖系统时。

处理 Pulse 异常

如果在捕获 Pulse 数据时发生异常,例如无法连接到存储数据库,Pulse 将静默失败以避免影响您的应用程序。

如果您希望自定义如何处理这些异常,您可以向 handleExceptionsUsing 方法提供一个闭包:

php
use Laravel\Pulse\Facades\Pulse;
use Illuminate\Support\Facades\Log;

Pulse::handleExceptionsUsing(function ($e) {
    Log::debug('Pulse 中发生异常', [
        'message' => $e->getMessage(),
        'stack' => $e->getTraceAsString(),
    ]);
});

自定义卡片

Pulse 允许您构建自定义卡片,以显示与您应用程序特定需求相关的数据。Pulse 使用 Livewire,因此您可能希望在构建第一个自定义卡片之前 查看其文档

卡片组件

在 Laravel Pulse 中创建自定义卡片的第一步是扩展基本的 Card Livewire 组件并定义相应的视图:

php
namespace App\Livewire\Pulse;

use Laravel\Pulse\Livewire\Card;
use Livewire\Attributes\Lazy;

#[Lazy]
class TopSellers extends Card
{
    public function render()
    {
        return view('livewire.pulse.top-sellers');
    }
}

使用 Livewire 的 懒加载 功能时,Card 组件将自动提供一个占位符,尊重传递给组件的 colsrows 属性。

在编写 Pulse 卡片的相应视图时,您可以利用 Pulse 的 Blade 组件,以保持一致的外观和感觉:

blade
<x-pulse::card :cols="$cols" :rows="$rows" :class="$class" wire:poll.5s="">
    <x-pulse::card-header name="Top Sellers">
        <x-slot:icon>
            ...
        </x-slot:icon>
    </x-pulse::card-header>

    <x-pulse::scroll :expand="$expand">
        ...
    </x-pulse::scroll>
</x-pulse::card>

$cols$rows$class$expand 变量应传递给各自的 Blade 组件,以便可以从仪表板视图自定义卡片布局。您可能还希望在视图中包含 wire:poll.5s="" 属性,以使卡片自动更新。

一旦您定义了 Livewire 组件和模板,该卡片可以在您的 仪表板视图 中包含:

blade
<x-pulse>
    ...

    <livewire:pulse.top-sellers cols="4" />
</x-pulse>

NOTE

如果您的卡片包含在一个包中,您需要使用 Livewire::component 方法注册该组件。

样式

如果您的卡片需要超出 Pulse 中包含的类和组件的额外样式,您有几种选项可以为您的卡片包含自定义 CSS。

Laravel Vite 集成

如果您的自定义卡片位于应用程序的代码库中,并且您正在使用 Laravel 的 Vite 集成,您可以更新 vite.config.js 文件,以包含卡片的专用 CSS 入口点:

js
laravel({
    input: [
        'resources/css/pulse/top-sellers.css',
        // ...
    ],
}),

然后,您可以在 仪表板视图 中使用 @vite Blade 指令,指定卡片的 CSS 入口点:

blade
<x-pulse>
    @vite('resources/css/pulse/top-sellers.css')

    ...
</x-pulse>

CSS 文件

对于其他用例,包括包含在包中的 Pulse 卡片,您可以通过在 Livewire 组件上定义 css 方法,返回 CSS 文件的路径,指示 Pulse 加载附加样式表:

php
class TopSellers extends Card
{
    // ...

    protected function css()
    {
        return __DIR__.'/../../dist/top-sellers.css';
    }
}

当此卡片包含在仪表板上时,Pulse 将自动在 <style> 标签中包含此文件的内容,因此不需要将其发布到 public 目录。

Tailwind CSS

在使用 Tailwind CSS 时,您应创建一个专用的 Tailwind 配置文件,以避免加载不必要的 CSS 或与 Pulse 的 Tailwind 类冲突:

js
export default {
    darkMode: 'class',
    important: '#top-sellers',
    content: [
        './resources/views/livewire/pulse/top-sellers.blade.php',
    ],
    corePlugins: {
        preflight: false,
    },
};

然后,您可以在 CSS 入口点中指定配置文件:

css
@config "../../tailwind.top-sellers.config.js";
@tailwind base;
@tailwind components;
@tailwind utilities;

您还需要在卡片的视图中包含一个与传递给 Tailwind 的 important 选择器策略 匹配的 idclass 属性:

blade
<x-pulse::card id="top-sellers" :cols="$cols" :rows="$rows" class="$class">
    ...
</x-pulse::card>

数据捕获和聚合

自定义卡片可以从任何地方获取和显示数据;但是,您可能希望利用 Pulse 强大而高效的数据记录和聚合系统。

捕获条目

Pulse 允许您使用 Pulse::record 方法记录“条目”:

php
use Laravel\Pulse\Facades\Pulse;

Pulse::record('user_sale', $user->id, $sale->amount)
    ->sum()
    ->count();

提供给 record 方法的第一个参数是您正在记录的条目的 type,第二个参数是确定如何对聚合数据进行分组的 key。对于大多数聚合方法,您还需要指定要聚合的 value。在上面的示例中,被聚合的值是 $sale->amount。然后,您可以调用一个或多个聚合方法(例如 sum),以便 Pulse 可以将预聚合值捕获到“桶”中,以便稍后高效检索。

可用的聚合方法有:

  • avg
  • count
  • max
  • min
  • sum

NOTE

在构建捕获当前经过身份验证的用户 ID 的卡片包时,您应使用 Pulse::resolveAuthenticatedUserId() 方法,该方法尊重对应用程序所做的任何 用户解析器自定义

检索聚合数据

在扩展 Pulse 的 Card Livewire 组件时,您可以使用 aggregate 方法检索仪表板中查看的时间段的聚合数据:

php
class TopSellers extends Card
{
    public function render()
    {
        return view('livewire.pulse.top-sellers', [
            'topSellers' => $this->aggregate('user_sale', ['sum', 'count'])
        ]);
    }
}

aggregate 方法返回一个 PHP stdClass 对象的集合。每个对象将包含之前捕获的 key 属性,以及每个请求的聚合的键:

@foreach ($topSellers as $seller)
    {{ $seller->key }}
    {{ $seller->sum }}
    {{ $seller->count }}
@endforeach

Pulse 将主要从预聚合的桶中检索数据;因此,指定的聚合必须在使用 Pulse::record 方法时预先捕获。最旧的桶通常会部分超出该时间段,因此 Pulse 将聚合最旧的条目以填补空白,并为整个时间段提供准确的值,而无需在每个轮询请求中聚合整个时间段。

您还可以使用 aggregateTotal 方法检索给定类型的总值。例如,以下方法将检索所有用户销售的总和,而不是按用户分组。

php
$total = $this->aggregateTotal('user_sale', 'sum');

显示用户

在处理记录用户 ID 作为键的聚合时,您可以使用 Pulse::resolveUsers 方法解析键到用户记录:

php
$aggregates = $this->aggregate('user_sale', ['sum', 'count']);

$users = Pulse::resolveUsers($aggregates->pluck('key'));

return view('livewire.pulse.top-sellers', [
    'sellers' => $aggregates->map(fn ($aggregate) => (object) [
        'user' => $users->find($aggregate->key),
        'sum' => $aggregate->sum,
        'count' => $aggregate->count,
    ])
]);

find 方法返回一个包含 nameextraavatar 键的对象,您可以选择直接将其传递给 <x-pulse::user-card> Blade 组件:

blade
<x-pulse::user-card :user="{{ $seller->user }}" :stats="{{ $seller->sum }}" />

自定义记录器

包作者可能希望提供记录器类,以允许用户配置数据捕获。

记录器在应用程序的 config/pulse.php 配置文件的 recorders 部分中注册:

php
[
    // ...
    'recorders' => [
        Acme\Recorders\Deployments::class => [
            // ...
        ],

        // ...
    ],
]

记录器可以通过指定 $listen 属性来监听事件。Pulse 将自动注册监听器并调用记录器的 record 方法:

php
<?php

namespace Acme\Recorders;

use Acme\Events\Deployment;
use Illuminate\Support\Facades\Config;
use Laravel\Pulse\Facades\Pulse;

class Deployments
{
    /**
     * 要监听的事件。
     *
     * @var array<int, class-string>
     */
    public array $listen = [
        Deployment::class,
    ];

    /**
     * 记录部署。
     */
    public function record(Deployment $event): void
    {
        $config = Config::get('pulse.recorders.'.static::class);

        Pulse::record(
            // ...
        );
    }
}