Laravel Pulse

介绍
安装
- 配置
仪表板
捕获条目
- 记录器
- 过滤
性能
自定义卡片

介绍

Laravel Pulse 提供了对应用程序性能和使用情况的一目了然的见解。通过 Pulse，您可以追踪瓶颈，如慢作业和端点，找到最活跃的用户等。

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

安装

Pulse 的一方存储实现目前需要 MySQL 或 PostgreSQL 数据库。如果您使用的是其他数据库引擎，则需要为 Pulse 数据提供单独的 MySQL 或 PostgreSQL 数据库。

由于 Pulse 目前处于测试阶段，您可能需要调整应用程序的 composer.json 文件以允许安装测试版软件包：

json

"minimum-stability": "beta",
"prefer-stable": true

然后，您可以使用 Composer 包管理器将 Pulse 安装到您的 Laravel 项目中：

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 仪表板。

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

配置

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

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

仪表板

授权

可以通过 /pulse 路由访问 Pulse 仪表板。默认情况下，您只能在 local 环境中访问此仪表板，因此您需要通过自定义 'viewPulse' 授权门来为生产环境配置授权。您可以在应用程序的 app/Providers/AuthServiceProvider.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：

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>

每个卡片接受 cols 和 rows 属性来控制空间和定位：

blade

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

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

blade

<livewire:pulse.slow-queries expand />

解析用户

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

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

user 方法接受一个闭包，该闭包将接收要显示的 Authenticatable 模型，并应返回一个包含 name、extra 和 avatar 信息的数组：

php

use Laravel\Pulse\Facades\Pulse;

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

    // ...
}

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

卡片

服务器

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

应用程序使用

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

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

blade

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

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

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

异常

<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 查询进行分组，可以选择不捕获位置。

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

慢出站请求

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

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

缓存

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

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

捕获条目

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

php

php artisan pulse:check

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

由于 pulse:check 命令是一个长时间运行的进程，因此在不重新启动的情况下不会看到代码库的更改。您应该在应用程序的部署过程中通过调用 pulse:restart 命令来优雅地重新启动命令：

php artisan pulse:restart

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

记录器

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

缓存交互

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

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

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

php

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

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

异常

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

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

队列

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

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

慢作业

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

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

慢出站请求

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

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

您还可以配置 URL 分组，以便将相似的 URL 分组为单个条目。例如，您可能希望从 URL 路径中删除唯一 ID 或仅按域分组。组是使用正则表达式来“查找和替换”URL 的部分进行配置的。配置文件中包含了一些示例：

php

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

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

慢查询

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

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

慢请求

Requests 记录器捕获应用程序中发出的请求信息，以显示在慢请求和应用程序使用卡片上。

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

服务器

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

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

PULSE_SERVER_NAME=load-balancer

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

用户作业

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

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

用户请求

UserRequests 记录器捕获应用程序中发出请求的用户信息，以显示在应用程序使用卡片上。

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

过滤

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

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 采集

Redis 采集需要 Redis 6.2 或更高版本，并且 phpredis 或 predis 作为应用程序配置的 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

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

由于 pulse:work 命令是一个长时间运行的进程，因此在不重新启动的情况下不会看到代码库的更改。您应该在应用程序的部署过程中通过调用 pulse:restart 命令来优雅地重新启动命令：

php artisan pulse:restart

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

采样

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

您可以选择在某些 Pulse 数据记录器上启用“采样”。例如，在 User Requests 记录器上将采样率设置为 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('An exception happened in 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 组件将自动提供一个尊重传递给组件的 cols 和 rows 属性的占位符。

在编写 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>

如果您的卡片包含在包中，则需要使用 Livewire::component 方法向 Livewire 注册组件。

样式

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

Laravel Vite 集成

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

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 方法来指示 Pulse 加载额外的样式表，该方法返回 CSS 文件的路径：

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 类冲突：

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;

您还需要在卡片视图中包含一个 id 或 class 属性，该属性与传递给 Tailwind 的重要选择器策略匹配：

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

在构建捕获当前经过身份验证的用户 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 方法返回一个包含 name、extra 和 avatar 键的对象，您可以选择直接传递给 <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 list<class-string>
     */
    public array $listen = [
        Deployment::class,
    ];

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

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

Laravel Pulse ​

介绍 ​

安装 ​

配置 ​

仪表板 ​

授权 ​

自定义 ​

解析用户 ​

卡片 ​

服务器 ​

应用程序使用 ​

异常 ​

队列 ​

慢请求 ​

慢作业 ​

慢查询 ​

慢出站请求 ​

缓存 ​

捕获条目 ​

记录器 ​

缓存交互 ​

异常 ​

队列 ​

慢作业 ​

慢出站请求 ​

慢查询 ​

慢请求 ​

服务器 ​

用户作业 ​

用户请求 ​

过滤 ​

性能 ​

使用不同的数据库 ​

Redis 采集 ​

采样 ​

修剪 ​

处理 Pulse 异常 ​

自定义卡片 ​

卡片组件 ​

样式 ​

Laravel Vite 集成 ​

CSS 文件 ​

Tailwind CSS ​

数据捕获和聚合 ​

捕获条目 ​

检索聚合数据 ​

显示用户 ​

自定义记录器 ​

Laravel Pulse

介绍

安装

配置

仪表板

授权

自定义

解析用户

卡片

服务器

应用程序使用

异常

队列

慢请求

慢作业

慢查询

慢出站请求

缓存

捕获条目

记录器

缓存交互

异常

队列

慢作业

慢出站请求

慢查询

慢请求

服务器

用户作业

用户请求

过滤

性能

使用不同的数据库

Redis 采集

采样

修剪

处理 Pulse 异常

自定义卡片

卡片组件

样式

Laravel Vite 集成

CSS 文件

Tailwind CSS

数据捕获和聚合

捕获条目

检索聚合数据

显示用户

自定义记录器