バージョン: 10.x

Laravel Pulse

Introduction
Installation
- Configuration
Dashboard
Capturing Entries
- Recorders
- Filtering
Performance
Custom Cards

Introduction

Laravel Pulse は、アプリケーションのパフォーマンスと使用状況を一目で把握できる情報を提供します。 Pulse を使用すると、遅いジョブやエンドポイントなどのボトルネックを追跡したり、最もアクティブなユーザーを見つけたりすることができます。

個々のイベントの詳細なデバッグについては、Laravel Telescope を確認してください。

Installation

Pulse のファーストパーティストレージ実装には現在、MySQL または PostgreSQL データベースが必要です。別のデータベースエンジンを使用している場合は、Pulse データ用に別の MySQL または PostgreSQL データベースが必要になります。

Pulse は現在ベータ版であるため、ベータパッケージリリースをインストールできるようにアプリケーションの composer.json ファイルを調整する必要がある場合があります。

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

次に、Composer パッケージマネージャーを使用して、Pulse を Laravel プロジェクトにインストールできます。

composer require laravel/pulse

次に、vendor:publish Artisan コマンドを使用して、Pulse 構成ファイルと移行ファイルを公開する必要があります。

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

最後に、migrate コマンドを実行して、Pulse のデータを保存するために必要なテーブルを作成する必要があります。

php artisan migrate

Pulse のデータベース移行が実行されると、/pulse ルート経由で Pulse ダッシュボードにアクセスできるようになります。

Pulse データをアプリケーションのプライマリデータベースに保存したくない場合は、specify a dedicated database connection を実行できます。

Configuration

Pulse の構成オプションの多くは、環境変数を使用して制御できます。利用可能なオプションを確認したり、新しいレコーダーを登録したり、詳細オプションを構成したりするには、config/pulse.php 構成ファイルを公開します。

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

Dashboard

Authorization

Pulse ダッシュボードには、/pulse ルート経由でアクセスできます。デフォルトでは、local 環境でのみこのダッシュボードにアクセスできるため、'viewPulse' 認可ゲートをカスタマイズして実稼働環境の認可を構成する必要があります。これは、アプリケーションの app/Providers/AuthServiceProvider.php ファイル内で実行できます。

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

/**
 * Register any authentication / authorization services.
 */
public function boot(): void
{
    Gate::define('viewPulse', function (User $user) {
        return $user->isAdmin();
    });

    // ...
}

Customization

Pulse ダッシュボードカードとレイアウトは、ダッシュボードビューを公開することで構成できます。ダッシュボードビューは resources/views/vendor/pulse/dashboard.blade.php に公開されます。

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

ダッシュボードは Livewire を利用しており、JavaScript アセットを再構築することなくカードとレイアウトをカスタマイズできます。

このファイル内では、<x-pulse> コンポーネントがダッシュボードのレンダリングを担当し、カードのグリッドレイアウトを提供します。ダッシュボードを画面の幅全体に広げたい場合は、コンポーネントに full-width プロパティを指定できます。

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

デフォルトでは、<x-pulse> コンポーネントは 12 列のグリッドを作成しますが、cols プロパティを使用してこれをカスタマイズできます。

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

各カードは、スペースと位置を制御するための cols および rows プロップを受け入れます。

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

ほとんどのカードは、スクロールする代わりにカード全体を表示する expand プロップも受け入れます。

<livewire:pulse.slow-queries expand />

Resolving Users

アプリケーション使用状況カードなど、ユーザーに関する情報を表示するカードの場合、Pulse はユーザーの ID のみを記録します。ダッシュボードをレンダリングするとき、Pulse はデフォルトの Authenticatable モデルから name フィールドと email フィールドを解決し、Gravatar Web サービスを使用してアバターを表示します。

アプリケーションの App\Providers\AppServiceProvider クラス内で Pulse::user メソッドを呼び出すことで、フィールドとアバターをカスタマイズできます。

user メソッドは、表示される Authenticatable モデルを受け取るクロージャーを受け入れ、ユーザーの name、extra、および avatar 情報を含む配列を返す必要があります。

use Laravel\Pulse\Facades\Pulse;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Pulse::user(fn ($user) => [
        'name' => $user->name,
        'extra' => $user->email,
        'avatar' => $user->avatar_url,
    ]);

    // ...
}

Laravel\Pulse\Contracts\ResolvesUsers コントラクトを実装し、Laravel の service container にバインドすることで、認証されたユーザーのキャプチャおよび取得方法を完全にカスタマイズできます。

Cards

Servers

<livewire:pulse.servers /> カードには、pulse:check コマンドを実行しているすべてのサーバーのシステムリソース使用量が表示されます。システムリソースレポートの詳細については、servers recorder に関するドキュメントを参照してください。

Application Usage

<livewire:pulse.usage /> カードには、アプリケーションにリクエストを行ったり、ジョブをディスパッチしたり、リクエストの速度が遅くなったりしている上位 10 人のユーザーが表示されます。

すべての使用状況メトリクスを画面上に同時に表示したい場合は、カードを複数回含めて、type 属性を指定できます。

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

Pulse がユーザー情報を取得して表示する方法をカスタマイズする方法については、resolving users のドキュメントを参照してください。

アプリケーションが大量のリクエストを受信したり、大量のジョブをディスパッチしたりする場合は、sampling を有効にすることができます。詳細については、user requests recorder、user jobs recorder、および slow jobs recorder のドキュメントを参照してください。

Exceptions

<livewire:pulse.exceptions /> カードは、アプリケーションで発生する例外の頻度と最新性を示します。デフォルトでは、例外は例外クラスと例外が発生した場所に基づいてグループ化されます。詳細については、exceptions recorder のドキュメントを参照してください。

Queues

<livewire:pulse.queues /> カードには、キューに入れられたジョブ、処理中のジョブ、処理されたジョブ、リリースされたジョブ、失敗したジョブの数など、アプリケーションのキューのスループットが表示されます。詳細については、queues recorder のドキュメントを参照してください。

Slow Requests

<livewire:pulse.slow-requests /> カードは、設定されたしきい値 (デフォルトでは 1,000 ミリ秒) を超える、アプリケーションへの受信リクエストを表示します。詳細については、slow requests recorder のドキュメントを参照してください。

Slow Jobs

<livewire:pulse.slow-jobs /> カードには、設定されたしきい値 (デフォルトでは 1,000 ミリ秒) を超える、アプリケーション内のキューに入れられたジョブが表示されます。詳細については、slow jobs recorder のドキュメントを参照してください。

Slow Queries

<livewire:pulse.slow-queries /> カードには、設定されたしきい値 (デフォルトでは 1,000 ミリ秒) を超えるアプリケーション内のデータベースクエリが表示されます。

デフォルトでは、遅いクエリは SQL クエリ (バインドなし) とそれが発生した場所に基づいてグループ化されますが、SQL クエリのみに基づいてグループ化したい場合は、場所を取得しないことも選択できます。

詳細については、slow queries recorder のドキュメントを参照してください。

Slow Outgoing Requests

<livewire:pulse.slow-outgoing-requests /> カードは、Laravel の HTTP client を使用して行われた、設定されたしきい値 (デフォルトでは 1,000 ミリ秒) を超える送信リクエストを示します。

デフォルトでは、エントリは完全な URL によってグループ化されます。ただし、正規表現を使用して、同様の送信リクエストを正規化またはグループ化したい場合があります。詳細については、slow outgoing requests recorder のドキュメントを参照してください。

Cache

<livewire:pulse.cache /> カードは、アプリケーションのキャッシュヒットとミスの統計を、グローバルと個々のキーの両方で表示します。

デフォルトでは、エントリはキーごとにグループ化されます。ただし、正規表現を使用して類似したキーを正規化またはグループ化したい場合があります。詳細については、cache interactions recorder のドキュメントを参照してください。

Capturing Entries

ほとんどの Pulse レコーダーは、Laravel によって送出されたフレームワークイベントに基づいてエントリを自動的にキャプチャします。ただし、servers recorder および一部のサードパーティカードは定期的に情報をポーリングする必要があります。これらのカードを使用するには、すべての個々のアプリケーションサーバーで pulse:check デーモンを実行する必要があります。

php artisan pulse:check

pulse:check プロセスをバックグラウンドで永続的に実行し続けるには、Supervisorなどのプロセスモニターを使用して、コマンドの実行が停止しないようにする必要があります。

pulse:check コマンドは存続期間の長いプロセスであるため、再起動しない限りコードベースへの変更は表示されません。アプリケーションのデプロイメントプロセス中に pulse:restart コマンドを呼び出して、コマンドを正常に再起動する必要があります。

php artisan pulse:restart

Pulse は cache を使用して再起動信号を保存するため、この機能を使用する前に、キャッシュドライバがアプリケーションに対して適切に構成されていることを確認する必要があります。

Recorders

レコーダーは、アプリケーションからエントリを取得して Pulse データベースに記録する役割を果たします。レコーダーは、Pulse configuration file の recorders セクションで登録および構成されます。

Cache Interactions

CacheInteractions レコーダーは、アプリケーションで発生する cache のヒットとミスに関する情報をキャプチャし、Cache カードに表示します。

必要に応じて、sample rate および無視されるキーパターンを調整できます。

同様のキーが 1 つのエントリとしてグループ化されるように、キーのグループ化を構成することもできます。たとえば、同じ種類の情報をキャッシュしているキーから一意の ID を削除したい場合があります。グループは、キーの一部を「検索して置換」するための正規表現を使用して構成されます。例は構成ファイルに含まれています。

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

最初に一致したパターンが使用されます。一致するパターンがない場合、キーはそのままキャプチャされます。

Exceptions

Exceptions レコーダーは、アプリケーションで発生する報告可能な例外に関する情報をキャプチャし、Exceptions カードに表示します。

必要に応じて、sample rate および無視される例外パターンを調整できます。例外の発生元の場所をキャプチャするかどうかを構成することもできます。キャプチャされた位置は Pulse ダッシュボードに表示され、例外の原因を追跡するのに役立ちます。ただし、同じ例外が複数の場所で発生する場合は、一意の場所ごとに複数回表示されます。

Queues

Queues レコーダーは、Queues に表示するためにアプリケーションキューに関する情報をキャプチャします。

必要に応じて、sample rate および無視されたジョブパターンを調整できます。

Slow Jobs

SlowJobs レコーダーは、アプリケーションで発生する遅いジョブに関する情報をキャプチャし、Slow Jobs カードに表示します。

オプションで、低速ジョブしきい値 sample rate および無視されるジョブパターンを調整できます。

Slow Outgoing Requests

SlowOutgoingRequests レコーダーは、Laravel の HTTP client を使用して行われた、Slow Outgoing Requests カードに表示するために構成されたしきい値を超える送信 HTTP リクエストに関する情報をキャプチャします。

オプションで、低速送信リクエストのしきい値、sample rate、および無視される URL パターンを調整できます。

同様の URL が 1 つのエントリとしてグループ化されるように、URL グループ化を構成することもできます。たとえば、URL パスから一意の ID を削除したり、ドメインのみでグループ化したりすることができます。グループは、URL の一部を「検索して置換」するための正規表現を使用して構成されます。構成ファイルにはいくつかの例が含まれています。

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

最初に一致したパターンが使用されます。一致するパターンがない場合、URL はそのままキャプチャされます。

Slow Queries

SlowQueries レコーダーは、Slow Queries カードに表示するために設定されたしきい値を超えるアプリケーション内のデータベースクエリをキャプチャします。

オプションで、低速クエリしきい値 sample rate および無視されるクエリパターンを調整できます。クエリの場所をキャプチャするかどうかを構成することもできます。キャプチャされた位置は Pulse ダッシュボードに表示され、クエリの発信元を追跡するのに役立ちます。ただし、同じクエリが複数の場所で作成された場合は、一意の場所ごとに複数回表示されます。

Slow Requests

Requests レコーダーは、Slow Requests カードおよび Application Usage カードに表示するためにアプリケーションに対して行われたリクエストに関する情報をキャプチャします。

オプションで、低速ルートのしきい値、sample rate、および無視されるパスを調整できます。

Servers

Servers レコーダーは、Servers カードに表示するためにアプリケーションに電力を供給するサーバーの CPU、メモリ、ストレージの使用状況をキャプチャします。このレコーダーを使用するには、監視する各サーバー上で pulse:check command が実行されている必要があります。

各レポートサーバーには一意の名前が必要です。デフォルトでは、Pulse は PHP の gethostname 関数によって返された値を使用します。これをカスタマイズしたい場合は、PULSE_SERVER_NAME 環境変数を設定します。

PULSE_SERVER_NAME=load-balancer

Pulse 構成ファイルを使用すると、監視されるディレクトリをカスタマイズすることもできます。

User Jobs

UserJobs レコーダーは、アプリケーションでジョブをディスパッチしているユーザーに関する情報をキャプチャし、Application Usage カードに表示します。

必要に応じて、sample rate および無視されたジョブパターンを調整できます。

User Requests

UserRequests レコーダーは、Application Usage カードに表示するためにアプリケーションにリクエストを行っているユーザーに関する情報をキャプチャします。

必要に応じて、sample rate および無視されたジョブパターンを調整できます。

Filtering

これまで見てきたように、多くの recorders は、構成を通じて、リクエストの URL などの値に基づいて受信エントリを「無視」する機能を提供します。ただし、現在認証されているユーザーなど、他の要素に基づいてレコードをフィルターで除外すると便利な場合があります。これらのレコードをフィルターで除外するには、Pulse の filter メソッドにクロージャを渡すことができます。通常、filter メソッドは、アプリケーションの AppServiceProvider の boot メソッド内で呼び出す必要があります。

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

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Pulse::filter(function (Entry|Value $entry) {
        return Auth::user()->isNotAdmin();
    });

    // ...
}

Performance

Pulse は、追加のインフラストラクチャを必要とせずに、既存のアプリケーションに組み込めるように設計されています。ただし、トラフィックの多いアプリケーションの場合、Pulse がアプリケーションのパフォーマンスに与える影響を取り除く方法がいくつかあります。

Using a Different Database

トラフィックの多いアプリケーションの場合は、アプリケーションデータベースへの影響を避けるために、Pulse 専用のデータベース接続を使用することをお勧めします。

PULSE_DB_CONNECTION 環境変数を設定することで、Pulse によって使用される database connection をカスタマイズできます。

PULSE_DB_CONNECTION=pulse

Redis Ingest

Redis Ingest には、Redis 6.2 以降と、アプリケーションの構成済み Redis クライアントドライバとして phpredis または predis が必要です。

デフォルトでは、Pulse は、HTTP 応答がクライアントに送信された後、またはジョブが処理された後、エントリを configured database connection に直接保存します。ただし、代わりに Pulse の Redis インジェストドライバを使用して、エントリを Redis ストリームに送信することもできます。これは、PULSE_INGEST_DRIVER 環境変数を構成することで有効にできます。

PULSE_INGEST_DRIVER=redis

Pulse はデフォルトでデフォルトの Redis connection を使用しますが、PULSE_REDIS_CONNECTION 環境変数を使用してこれをカスタマイズできます。

PULSE_REDIS_CONNECTION=pulse

Redis インジェストを使用する場合、pulse:work コマンドを実行してストリームを監視し、エントリを Redis から Pulse のデータベーステーブルに移動する必要があります。

php artisan pulse:work

pulse:work プロセスをバックグラウンドで永続的に実行し続けるには、Supervisorなどのプロセスモニターを使用して、Pulse ワーカーの実行が停止しないようにする必要があります。

pulse:work コマンドは存続期間の長いプロセスであるため、再起動しない限りコードベースへの変更は表示されません。アプリケーションのデプロイメントプロセス中に pulse:restart コマンドを呼び出して、コマンドを正常に再起動する必要があります。

php artisan pulse:restart

Pulse は cache を使用して再起動信号を保存するため、この機能を使用する前に、キャッシュドライバがアプリケーションに対して適切に構成されていることを確認する必要があります。

Sampling

デフォルトでは、Pulse はアプリケーションで発生するすべての関連イベントをキャプチャします。トラフィックの多いアプリケーションの場合、特に長期間にわたって、ダッシュボードに何百万ものデータベース行を集約する必要が生じる可能性があります。

代わりに、特定の Pulse データレコーダーで「サンプリング」を有効にすることを選択できます。たとえば、User Requests レコーダーでサンプルレートを 0.1 に設定すると、アプリケーションへのリクエストの約 10% のみが記録されることになります。ダッシュボードでは、値がスケールアップされ、近似値であることを示すために ~ という接頭辞が付けられます。

一般に、特定のメトリクスのエントリが多いほど、精度をあまり犠牲にすることなくサンプルレートを安全に低く設定できます。

Trimming

Pulse は、保存されているエントリがダッシュボードウィンドウの外に出ると、自動的にトリミングします。トリミングは、Pulse configuration file でカスタマイズできる抽選システムを使用してデータを取り込むときに発生します。

Handling Pulse Exceptions

ストレージデータベースに接続できないなど、Pulse データのキャプチャ中に例外が発生した場合、Pulse はアプリケーションへの影響を回避するためにサイレントに失敗します。

これらの例外の処理方法をカスタマイズしたい場合は、handleExceptionsUsing メソッドにクロージャを提供できます。

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(),
    ]);
});

Custom Cards

Pulse を使用すると、アプリケーションの特定のニーズに関連するデータを表示するカスタムカードを作成できます。 Pulse は Livewire を使用するため、最初のカスタムカードを作成する前に review its documentation を実行することをお勧めします。

Card Components

Laravel Pulse でカスタムカードを作成するには、ベースの Card Livewire コンポーネントを拡張し、対応するビューを定義することから始まります。

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 の lazy loading 機能を使用する場合、Card コンポーネントは、コンポーネントに渡された cols 属性と rows 属性を尊重するプレースホルダーを自動的に提供します。

Pulse カードの対応するビューを作成するときは、一貫したルックアンドフィールを実現するために Pulse の 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 コンポーネントとテンプレートを定義したら、カードを dashboard view に含めることができます。

<x-pulse>
    ...

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

カードがパッケージに含まれている場合は、Livewire::component メソッドを使用してコンポーネントを Livewire に登録する必要があります。

Styling

カードに Pulse に含まれるクラスやコンポーネント以外の追加のスタイルが必要な場合は、カードにカスタム CSS を含めるオプションがいくつかあります。

Laravel Vite Integration

カスタムカードがアプリケーションのコードベース内にあり、Laravel の Vite integration を使用している場合は、vite.config.js ファイルを更新して、カードの専用 CSS エントリポイントを含めることができます。

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

次に、dashboard view で @vite Blade ディレクティブを使用し、カードの CSS エントリポイントを指定します。

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

    ...
</x-pulse>

CSS Files

パッケージ内に含まれる Pulse カードなど、他の使用例では、CSS ファイルへのファイルパスを返す Livewire コンポーネントで css メソッドを定義することで、追加のスタイルシートをロードするように Pulse に指示できます。

class TopSellers extends Card
{
    // ...

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

このカードがダッシュボードに含まれる場合、Pulse はこのファイルの内容を <style> タグ内に自動的に含めるため、public ディレクトリに公開する必要はありません。

Tailwind CSS

Tailwind CSS を使用する場合は、不要な CSS のロードや Pulse の Tailwind クラスとの競合を避けるために、専用の Tailwind 構成ファイルを作成する必要があります。

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

次に、CSS エントリポイントで構成ファイルを指定できます。

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

また、Tailwind の important selector strategy に渡されるセレクターと一致する id または class 属性をカードのビューに含める必要があります。

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

Data Capture and Aggregation

カスタムカードはどこからでもデータを取得して表示できます。ただし、Pulse の強力で効率的なデータ記録および集計システムを活用したい場合もあります。

Capturing Entries

Pulse では、Pulse::record メソッドを使用して「エントリ」を記録できます。

use Laravel\Pulse\Facades\Pulse;

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

record メソッドに指定される最初の引数は、記録しているエントリの type であり、2 番目の引数は、集計されたデータをグループ化する方法を決定する key です。ほとんどの集計方法では、集計対象の value も指定する必要があります。上の例では、集計される値は $sale->amount です。次に、1 つ以上の集計メソッド (sum など) を呼び出して、Pulse が事前に集計された値を「バケット」にキャプチャして、後で効率的に取得できるようにすることができます。

使用可能な集計方法は次のとおりです。

avg
count
max
min
sum

現在認証されているユーザー ID を取得するカードパッケージを構築する場合は、アプリケーションに対して作成された user resolver customizations を尊重する Pulse::resolveAuthenticatedUserId() メソッドを使用する必要があります。

Retrieving Aggregate Data

Pulse の Card Livewire コンポーネントを拡張する場合、aggregate メソッドを使用して、ダッシュボードに表示されている期間の集計データを取得できます。

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 メソッドを使用して、特定のタイプの合計値を取得することもできます。たとえば、次のメソッドは、ユーザーごとにグループ化するのではなく、すべてのユーザーの売上の合計を取得します。

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

Displaying Users

ユーザー ID をキーとして記録する集計を操作する場合、Pulse::resolveUsers メソッドを使用してキーをユーザーレコードに解決できます。

$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 コンポーネントに直接渡すこともできます。

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

Custom Recorders

パッケージ作成者は、ユーザーがデータのキャプチャを構成できるようにレコーダークラスを提供したい場合があります。

レコーダーは、アプリケーションの config/pulse.php 構成ファイルの recorders セクションに登録されます。

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

        // ...
    ],
]

レコーダーは、$listen プロパティを指定することでイベントをリッスンできます。 Pulse は自動的にリスナを登録し、レコーダーの record メソッドを呼び出します。

<?php

namespace Acme\Recorders;

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

class Deployments
{
    /**
     * The events to listen for.
     *
     * @var list<class-string>
     */
    public array $listen = [
        Deployment::class,
    ];

    /**
     * Record the deployment.
     */
    public function record(Deployment $event): void
    {
        $config = Config::get('pulse.recorders.'.static::class);

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

Introduction​

Installation​

Configuration​

Dashboard​

Authorization​

Customization​

Resolving Users​

Cards​

Servers​

Application Usage​

Exceptions​

Queues​

Slow Requests​

Slow Jobs​

Slow Queries​

Slow Outgoing Requests​

Cache​

Capturing Entries​

Recorders​

Cache Interactions​

Exceptions​

Queues​

Slow Jobs​

Slow Outgoing Requests​

Slow Queries​

Slow Requests​

Servers​

User Jobs​

User Requests​

Filtering​

Performance​

Using a Different Database​

Redis Ingest​

Sampling​

Trimming​

Handling Pulse Exceptions​

Custom Cards​

Card Components​

Styling​

Laravel Vite Integration​

CSS Files​

Tailwind CSS​

Data Capture and Aggregation​

Capturing Entries​

Retrieving Aggregate Data​

Displaying Users​

Custom Recorders​

Introduction

Installation

Configuration

Dashboard

Authorization

Customization

Resolving Users

Cards

Servers

Application Usage

Exceptions

Queues

Slow Requests

Slow Jobs

Slow Queries

Slow Outgoing Requests

Cache

Capturing Entries

Recorders

Cache Interactions

Exceptions

Queues

Slow Jobs

Slow Outgoing Requests

Slow Queries

Slow Requests

Servers

User Jobs

User Requests

Filtering

Performance

Using a Different Database

Redis Ingest

Sampling

Trimming

Handling Pulse Exceptions

Custom Cards

Card Components

Styling

Laravel Vite Integration

CSS Files

Tailwind CSS

Data Capture and Aggregation

Capturing Entries

Retrieving Aggregate Data

Displaying Users

Custom Recorders