Laravel Pulse

https://github.com/laravel/pulse
Admin
Laravel Pulse is a performance monitoring dashboard for Laravel apps that records slow jobs,...
Tokens:52,127
Snippets:468
Trust Score:9.7
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Value usage example

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/entry-and-value.md

Example of creating a Value instance and calling attributes().

```php
use Laravel\Pulse\Value;

$value = new Value(
    timestamp: time(),
    type: 'system',
    key: 'web-1',
    value: json_encode(['cpu' => 20, 'memory_used' => 1024], flags: JSON_THROW_ON_ERROR),
);

$value->attributes();
```

--------------------------------

### Entry usage example

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/entry-and-value.md

Example of creating an Entry instance, chaining max() and count(), and calling accessor methods.

```php
use Laravel\Pulse\Entry;

$entry = (new Entry(
    timestamp: time(),
    type: 'slow_request',
    key: json_encode(['GET', '/checkout', 'App\Http\Controllers\CheckoutController@show']),
    value: 2450,
))->max()->count();

$entry->isMax();                    // true
$entry->isCount();                  // true
$entry->aggregations();             // ['max', 'count']
$entry->attributes();               // ['timestamp' => ..., 'type' => 'slow_request', 'key' => ..., 'value' => 2450]
```

--------------------------------

### Application-facing configuration example

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorder-concerns.md

Demonstrates configuration for recorders in config/pulse.php, including sample_rate, threshold, ignore, and groups options.

```php
// config/pulse.php
Recorders\SlowQueries::class => [
    'sample_rate' => 0.5,                    // Sampling::shouldSample()
    'threshold' => 1000,                     // Thresholds::threshold() / underThreshold()
    'ignore' => ['/(["`])pulse_[\w]+?\1/'], // Ignores::shouldIgnore()
],
Recorders\CacheInteractions::class => [
    'groups' => ['/:\d+/' => ':*'],          // Groups::group()
],
```

--------------------------------

### Pulse Configuration Example

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/ingests.md

Example configuration for the Pulse ingest system in config/pulse.php.

```php
// config/pulse.php
'ingest' => [
    'driver' => env('PULSE_INGEST_DRIVER', 'storage'), // 'storage' | 'redis' | 'null'
    'buffer' => 5_000,
    'trim' => [
        'lottery' => [1, 1_000],
        'keep' => '7 days',
    ],
    'redis' => [
        'connection' => env('PULSE_REDIS_CONNECTION'),
        'chunk' => 1000,
    ],
],
```

--------------------------------

### Publish Pulse config and dashboard (Usage example)

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/service-provider.md

Publishes the config and dashboard files for customization.

```bash
php artisan vendor:publish --tag=pulse-config
php artisan vendor:publish --tag=pulse-dashboard
```

--------------------------------

### Config example for SlowJobs threshold

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorder-concerns.md

Example configuration showing per-pattern thresholds for the SlowJobs recorder, with a default of 2000 ms.

```php
Recorders\SlowJobs::class => [
    'threshold' => [
        '/^App\\Jobs\\/i' => 500,
        'default' => 2_000,
    ],
],
```

--------------------------------

### Configuring Pulse middleware

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/middleware.md

Example of adding custom middleware to the pulse configuration array.

```php
// config/pulse.php — add a custom middleware in front of the authorizer:

'middleware' => [
    'web',
    \App\Http\Middleware\EnsurePulseAudited::class,
    \Laravel\Pulse\Http\Middleware\Authorize::class,
],
```

--------------------------------

### Minimal configuration for config/pulse.php

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/configuration.md

A complete minimal configuration example for Laravel Pulse, including domain, path, storage, ingest, and middleware settings.

```php
// config/pulse.php
return [
    'domain' => env('PULSE_DOMAIN'),
    'path' => env('PULSE_PATH', 'pulse'),
    'enabled' => env('PULSE_ENABLED', true),
    'storage' => [
        'driver' => 'database',
        'trim' => ['keep' => '7 days'],
        'database' => ['connection' => env('PULSE_DB_CONNECTION'), 'chunk' => 1000],
    ],
    'ingest' => [
        'driver' => env('PULSE_INGEST_DRIVER', 'storage'),
        'buffer' => 5_000,
        'trim' => ['lottery' => [1, 1_000], 'keep' => '7 days'],
        'redis' => ['connection' => env('PULSE_REDIS_CONNECTION'), 'chunk' => 1000],
    ],
    'cache' => env('PULSE_CACHE_DRIVER'),
    'middleware' => ['web', \Laravel\Pulse\Http\Middleware\Authorize::class],
    'recorders' => [ /* per-recorder arrays above */ ],
];
```

--------------------------------

### Pulse User Resolution Usage Example

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/users.md

Demonstrates how to eager-load user records for a dashboard and customize user display fields.

```php
use Laravel\Pulse\Facades\Pulse;

// Eager-load the top users and render their display records:
$counts = Pulse::aggregate('user_request', 'count', $period, limit: 10);
$users = Pulse::resolveUsers($counts->pluck('key'));

foreach ($counts as $row) {
    $user = $users->find($row->key); // object{ name, extra, avatar }
}

// Customize what Pulse shows for each user:
Pulse::user(fn ($user) => [
    'name' => $user->full_name,
    'email' => $user->email,
    'avatar' => $user->avatar_url,
    'extra' => $user->team->name,
]);
```

--------------------------------

### Configure SlowOutgoingRequests in config/pulse.php

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorders-slow.md

Example configuration for SlowOutgoingRequests, including custom grouping for GitHub API URLs.

```php
// Config: only track requests slower than 2500ms, group GitHub API URLs
// config/pulse.php
Recorders\SlowRequests::class => [
    'enabled' => true,
    'sample_rate' => 0.1, // sample 10% of requests
    'threshold' => 2500,
    'ignore' => ['#^/pulse$#'],
],
Recorders\SlowQueries::class => [
    'threshold' => 500,
    'max_query_length' => 1000,
],
Recorders\SlowOutgoingRequests::class => [
    'groups' => [
        '#^https?://api\.github\.com/.*$#' => 'api.github.com/*',
    ],
],
```

--------------------------------

### Implementing a custom Livewire card

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/livewire-card.md

Example of extending the Pulse Card class and using the remember method to aggregate data.

```php
<?php

namespace App\/Livewire;

use Illuminate\Support\Collection;
use Laravel\Pulse\Livewire\Card;

class MyCard extends Card
{
    public function render(): Renderable
    {
        [$topUsers, $time, $runAt] = $this->remember(
            fn () => $this->aggregate('user_request', 'count', limit: 10),
            'top-users',
            10, // keep for 10 seconds
        );

        return view('cards.top-users', [
            'topUsers' => $topUsers,
            'time' => $time,
            'runAt' => $runAt,
        ]);
    }
}
```

--------------------------------

### Disable Pulse routes and mount dashboard at custom route (Usage example)

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/service-provider.md

Shows how to ignore Pulse's own routes in AppServiceProvider::boot().

```php
// AppServiceProvider::boot()
use Laravel\Pulse\Pulse;

// Disable Pulse's own routes and mount the dashboard at your own route.
Pulse::ignoreRoutes();
```

--------------------------------

### Usage example for aggregateTotal() and other Pulse methods

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/database-storage.md

Shows how to use aggregateTotal() to get totals for multiple types, along with aggregateTypes(), aggregate(), and values() methods. Includes a try-catch for InvalidArgumentException when an invalid aggregate name is passed.

```php
use Carbon\CarbonInterval;
use Laravel\Pulse\Facades\Pulse;

// Top 10 most-hit cache keys (hit + miss totals handled by aggregateTypes):
$topKeys = Pulse::aggregateTypes(['cache_hit', 'cache_miss'], 'count', CarbonInterval::hours(24), limit: 10);

// Slowest requests in the last hour:
$slowest = Pulse::aggregate('slow_request', ['max', 'count'], CarbonInterval::hour(), orderBy: 'max', limit: 25);

// Live server values:
$systems = Pulse::values('system');

try {
    $total = Pulse::aggregateTotal(['queued', 'processing'], 'count', CarbonInterval::hour());
} catch (InvalidArgumentException $e) {
    // Invalid aggregate name passed.
}
```

--------------------------------

### Servers recorder usage example with custom CPU and memory detection

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorders-counters.md

Shows how to provide custom CPU and memory readings from your own metrics layer, per server boot. The CPU callback returns the system load average as an integer, and the memory callback returns fixed values.

```php
use Laravel\Pulse\Recorders\Servers;

// Provide CPU/memory readings from your own metrics layer, per server boot:
Servers::detectCpuUsing(fn (): int => (int) sys_getloadavg()[0]);
Servers::detectMemoryUsing(fn (): array => [
    'total' => 16384,
    'used' => 8192,
]);
```

--------------------------------

### Usage examples for Pulse commands

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/commands.md

Shows typical command invocations: monitoring with pulse:check and pulse:work, CI/on-demand with --once and --stop-when-empty, and operations with pulse:restart and pulse:clear.

```bash
# Monitor: one check process + one work process per server (supervisor-managed)
php artisan pulse:check
php artisan pulse:work

# CI / on-demand
php artisan pulse:check --once
php artisan pulse:work --stop-when-empty

# Operations
php artisan pulse:restart              # gracefully stop running loops
php artisan pulse:clear --force        # truncate everything
php artisan pulse:clear --type=slow_query --type=exception --force
```

--------------------------------

### Accessing Pulse Cache and Redis

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/support.md

Examples of using CacheStoreResolver to access the Pulse cache store and RedisAdapter for custom Redis stream ingestion.

```php
use Laravel\Pulse\Support\CacheStoreResolver;
use Laravel\Pulse\Support\RedisAdapter;

// Access the same cache store the rest of Pulse uses:
$restartAt = app(CacheStoreResolver::class)->store()->get('laravel:pulse:restart');

// Drive Redis streams directly if building a custom ingest:
$redis = new RedisAdapter(
    app('redis')->connection('default'),
    app('config'),
);
$id = $redis->xadd('my-stream', ['data' => 'payload']);
```

--------------------------------

### Usage example for ExceptionReported event

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/events.md

Shows how to listen for the ExceptionReported event using Laravel's Event facade. Logs a warning with the exception class and message.

```php
use Illuminate\Support\Facades\Event;
use Laravel\Pulse\Events\ExceptionReported;

Event::listen(function (ExceptionReported $event) {
    logger()->warning('Pulse captured an exception', [
        'class' => $event->exception::class,
        'message' => $event->exception->getMessage(),
    ]);
});
```

--------------------------------

### Usage example for IsolatedBeat and SharedBeat events

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/events.md

Shows how to listen for both beat events. The SharedBeat listener records a metric for server health, and the IsolatedBeat listener refreshes an API token on exactly one server per tick.

```php
use Illuminate\Support\Facades\Event;
use Laravel\Pulse\Events\IsolatedBeat;
use Laravel\Pulse\Events\SharedBeat;

// Report server health once per second on every app server:
Event::listen(fn (SharedBeat $event) => recordMetric('heartbeat', (string) $event->time->getTimestamp()));

// Refresh an API token on exactly one server per tick:
Event::listen(fn (IsolatedBeat $event) => refreshOAuthToken($event->time));
```

--------------------------------

### Recorder trait usage example

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorder-concerns.md

Shows how a recorder class mixes in the Concerns traits to inherit throttling, ignoring, sampling, and threshold behavior.

```php
class SlowRequests
{
    use Concerns\Ignores, Concerns\Sampling, Concerns\Thresholds;
    // ...
}
```

--------------------------------

### Custom viewPulse gate definition

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/middleware.md

Example of defining a custom viewPulse gate in AppServiceProvider::boot() to restrict access based on user roles.

```php
use Illuminate	Support	Facades	Gate;

Gate::define('viewPulse', fn ($user) => $user->isAdmin());
```

--------------------------------

### SlowJobs listen property and record method signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorders-slow.md

The listen property lists the job events that trigger recording, and the record method signature accepts any of those events. JobProcessing stores the start time and returns; terminal events compute duration and record lazily when conditions are met.

```php
public array $listen = [
    JobReleasedAfterException::class,
    JobFailed::class,
    JobProcessed::class,
    JobProcessing::class,
];

public function record(JobReleasedAfterException|JobFailed|JobProcessed|JobProcessing $event): void
```

--------------------------------

### Pulse Filtering and Data Retrieval

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Examples for filtering entries, custom user field resolution, lazy capture, and reading data back from storage.

```php
use Laravel\Pulse\Facades\Pulse;

// Only keep entries whose key contains "orders".
Pulse::filter(fn (Entry|Value $entry) => str_contains($entry->key, 'orders'));

// Custom user field resolution; throws RuntimeException if the resolver
// does not implement setFieldResolver().
Pulse::user(fn ($user) => [
    'name' => $user->name,
    'email' => $user->email,
    'extra' => $user->plan,
]);

// Deferred capture — the closure runs at ingest time, not request time.
Pulse::lazy(fn () => Pulse::record('slow_job', $jobClass, duration: $ms)->max()->count());

// Reading data back happens through Storage forwards:
$values = Pulse::values('system');
$topUsers = Pulse::aggregate('user_request', 'count', CarbonInterval::hour(), limit: 10);
```

--------------------------------

### LegacyUsers::load()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/users.md

Invokes the constructor callback with the full key collection and stores the result.

```APIDOC
## load()

### Description
Invokes the constructor callback with the full key collection and stores the result.

### Method
load

### Parameters
- **$keys** (Illuminate\Support\Collection<int, int|string|null>) - Required - User keys to eager-load.

### Returns
self - Returns $this.
```

--------------------------------

### LegacyUsers constructor signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/users.md

Initializes the legacy resolver with a callback to fetch user data.

```php
public function __construct(protected $callback)
```

--------------------------------

### SlowRequests record method signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorders-slow.md

The record method is called at the end of each request lifecycle. It accepts the request start time, the request, and the response.

```php
public function record(Carbon $startedAt, Request $request, Response $response): void
```

--------------------------------

### RedisAdapter Constructor

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/support.md

Initializes the RedisAdapter with a Laravel Redis connection and configuration repository.

```php
public function __construct(
    protected Connection $connection,
    protected Repository $config,
    protected Pipeline|PhpRedis|Relay|null $client = null,
)
```

--------------------------------

### Catching RedisServerException

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/errors.md

Example of catching the custom RedisServerException when performing ingestion operations. You can inspect the error message or the previous exception using the provided methods.

```php
use Laravel\Pulse\Support\RedisServerException;

try {
    app(Ingest::class)->ingest($entries);
} catch (RedisServerException $e) {
    // Inspect $e->getMessage() / $e->getPrevious()
    report($e);
}
```

--------------------------------

### js()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Returns script tags for the Livewire runtime and the compiled Pulse front-end. Throws a RuntimeException if vendor assets are missing.

```php
public function js(): string
```

--------------------------------

### GET /{pulse.path}

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/endpoints.md

Renders the Pulse dashboard as a full-page HTML response. The route is registered by the Pulse service provider and is protected by the 'pulse' middleware group.

```APIDOC
## GET /{pulse.path}

### Description
Renders the Pulse dashboard as a full-page HTML response. The route is registered by the Pulse service provider and is protected by the 'pulse' middleware group.

### Method
GET

### Endpoint
/{config('pulse.path')} - default /pulse (env PULSE_PATH)

### Parameters
#### Query Parameters
- **usage** (string) - Optional - Default Usage card tab. Values: 'requests', 'slow_requests', 'jobs'.
- **period** (string) - Optional - Default dashboard period. Values: '1_hour', '6_hours', '24_hours', '7_days'.
- **exceptions** (string) - Optional - Exceptions card ordering. Values: 'count', 'latest'.
- **slow-jobs** (string) - Optional - Slow jobs card ordering. Values: 'slowest', 'count'.
- **slow-requests** (string) - Optional - Slow requests card ordering. Values: 'slowest', 'count'.
- **slow-queries** (string) - Optional - Slow queries card ordering. Values: 'slowest', 'count'.
- **slow-outgoing-requests** (string) - Optional - Slow outgoing requests card ordering. Values: 'slowest', 'count'.

### Response
#### Success Response (200)
- HTML head: Inline style from Pulse::css() and script tags from Pulse::js().
- Body: <x-pulse> markup containing ten <livewire:pulse.*> components with cols/rows.

#### Response Example
(HTML content not provided in source)

### Authentication
- Middleware group 'pulse' includes SentinelMiddleware (scope 'pulse') and configured middleware (default 'web' and Authorize).
- Authorize invokes the 'viewPulse' gate; default allows only local environment.
```

--------------------------------

### PulseMigration shouldRun method

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/support.md

Validates if the current database driver is supported by Pulse, throwing an exception for unsupported drivers or returning false when disabled in testing.

```php
public function shouldRun(): bool
```

--------------------------------

### Pulse Facade Implementation

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

The Pulse facade forwards public methods to the underlying singleton. This is defined in src/Facades/Pulse.php.

```php
class Pulse extends Facade
{
    public static function getFacadeAccessor(): string
    {
        return \Laravel\Pulse\Pulse::class;
    }
}
```

--------------------------------

### StorageIngest Methods

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/ingests.md

Methods for the StorageIngest driver.

```php
public function ingest(Collection $items): void   // Collection<int, Entry>
```

```php
public function trim(): void
```

```php
public function digest(Storage $storage): int
```

--------------------------------

### Entry constructor

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/entry-and-value.md

Constructor for the Entry class, which takes a timestamp, type, key, and optional value. The value is nullable and defaults to null.

```php
public function __construct(
    public int $timestamp,
    public string $type,
    public string $key,
    public ?int $value = null,
)
```

--------------------------------

### Handling RedisServerException

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/support.md

Demonstrates catching RedisServerException when performing operations like xadd on unsupported Redis servers.

```php
use Laravel\Pulse\Support\RedisServerException;

try {
    $redis->xadd('laravel:pulse:ingest', ['data' => serialize($entry)]);
} catch (RedisServerException $e) {
    // e.g. "Error running command [XADD ...]. Redis error: [...]"
    report($e);
}
```

--------------------------------

### LegacyUsers::__construct()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/users.md

Creates a new LegacyUsers instance with a callback that resolves user display data.

```APIDOC
## __construct()

### Description
Creates a new LegacyUsers instance with a callback that resolves user display data.

### Method
__construct

### Parameters
- **$callback** (callable) - Required - Receives Collection<int, int|string|null> of all keys and returns ?iterable<int|string, array{name: string, email?: ?string, avatar?: ?string, extra?: ?string}>.
```

--------------------------------

### __call()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Forwards unknown method calls to the bound Storage implementation, enabling methods like store, trim, purge, values, graph, aggregate, aggregateTypes, and aggregateTotal.

```APIDOC
## __call()

### Description
Forwards any unknown method to the bound Storage implementation via ForwardsCalls, wrapped in ignore(). This makes storage methods available on the Pulse facade.

### Method
__call()

### Signature
public function __call($method, $parameters): mixed

### Parameters
- **$method** (string) - Required - The method name to forward.
- **$parameters** (array) - Required - The parameters to pass to the method.

### Returns
- **mixed** - The result of the forwarded method call.

```

--------------------------------

### __call()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Forwards unknown method calls to the bound Storage implementation.

```php
public function __call($method, $parameters): mixed
```

--------------------------------

### startRecording() and stopRecording() method signatures

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Sets $shouldRecord to true or false. The service provider calls stopRecording() when pulse.enabled is false. Returns $this.

```php
public function startRecording(): self
public function stopRecording(): self
```

--------------------------------

### js()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Returns script tags for the Livewire runtime and the compiled Pulse front-end.

```APIDOC
## js()

### Description
Returns <script> tags containing the Livewire runtime and the compiled Pulse front-end JavaScript.

### Method
js()

### Signature
public function js(): string

### Returns
- **string** - The HTML script tags for the JavaScript assets.

### Throws
- **RuntimeException** - When the Livewire or Pulse JavaScript assets are missing.

```

--------------------------------

### CacheStoreResolver Constructor and store method

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/support.md

Resolves the cache store based on the pulse.cache configuration, falling back to the default store if null.

```php
public function __construct(
    protected CacheManager $cache,
    protected ConfigRepository $config,
)

public function store(): CacheRepository
```

--------------------------------

### RedisAdapter xadd()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/support.md

Adds an entry to a Redis stream with the configured prefix.

```php
public function xadd(string $key, array $dictionary): string|Pipeline|PhpRedis|Relay
```

--------------------------------

### startRecording() / stopRecording()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Controls whether recording is enabled. The service provider calls stopRecording() when pulse.enabled is false.

```APIDOC
## startRecording() / stopRecording()

### Description
Sets `$shouldRecord` to `true` / `false`. The service provider calls `stopRecording()` when `pulse.enabled` is `false`. Returns `$this`.

### Methods
- `startRecording(): self`
- `stopRecording(): self`

### Returns
- `self` - The recorder instance for chaining.
```

--------------------------------

### css()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Merges CSS paths into the dashboard or compiles and returns the aggregate CSS string. Throws a RuntimeException if a path cannot be read.

```php
public function css(string|Htmlable|array|null $css = null): string|self
```

--------------------------------

### record() method signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Records an entry with a type, key, optional value, and timestamp. Returns a new Entry appended to the buffer, or discarded if recording is disabled. Triggers a flush if the buffer exceeds the configured size.

```php
public function record(
    UnitEnum|string $type,
    UnitEnum|string $key,
    ?int $value = null,
    DateTimeInterface|int|null $timestamp = null,
): Entry
```

--------------------------------

### Register pulse route middleware group (PulseServiceProvider::boot)

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/service-provider.md

Defines the 'pulse' middleware group using SentinelMiddleware and user-configured middleware.

```php
Route::middlewareGroup('pulse', [
    SentinelMiddleware::class.':pulse',
    ...$this->app->make('config')->get('pulse.middleware', []),
]);
```

--------------------------------

### Configure recorder thresholds with pattern maps

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/configuration.md

The threshold option accepts a pattern map to define per-pattern overrides alongside a default value.

```php
// config/pulse.php
Recorders\SlowJobs::class => [
    'threshold' => [
        '/^App\\\\Jobs\\\\/i' => 500,   // per-pattern override
        'default' => 2_000,
    ],
],
```

--------------------------------

### Livewire ordering and usage types

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/types.md

Lists the allowed ordering and usage type values for various Livewire components. The first line applies to the slowest/count ordering for slow jobs, requests, queries, and outgoing requests. The second line applies to exceptions ordering, and the third to the usage type for the Usage component.

```php
@var 'slowest'|'count'      // SlowJobs, SlowRequests, SlowQueries, SlowOutgoingRequests::$orderBy
@var 'count'|'latest'       // Exceptions::$orderBy
@var 'requests'|'slow_requests'|'jobs'   // Usage::$usage (and ?type)
```

--------------------------------

### DatabaseStorage constructor

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/database-storage.md

Defines the constructor for DatabaseStorage, injecting the database manager and config repository. The config repository reads 'pulse.storage.database.connection' and 'pulse.storage.database.chunk'.

```php
public function __construct(
    protected DatabaseManager $db,
    protected Repository $config,
)
```

--------------------------------

### set() method signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Sets a value with a type, key, string payload, and timestamp. Returns a new Value buffer item with the same buffering semantics as record().

```php
public function set(
    UnitEnum|string $type,
    UnitEnum|string $key,
    string $value,
    DateTimeInterface|int|null $timestamp = null,
): Value
```

--------------------------------

### Servers recorder CPU and memory detection override methods

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorders-counters.md

These static methods allow overriding the default CPU and memory detection. The CPU callback must return an integer percentage, and the memory callback must return an array with total and used MB.

```php
public static function detectCpuUsing(?callable $callback): void
public static function detectMemoryUsing(?callable $callback): void
```

--------------------------------

### threshold method

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorder-concerns.md

Returns the threshold value for a given key, reading from the recorder's configuration. Supports per-pattern thresholds with a default fallback.

```php
protected function threshold(string $key, ?string $recorder = null): int
```

--------------------------------

### register(callable $record, Application $app): void

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorders-slow.md

Registers global HTTP client middleware to time outgoing requests and invoke the record callback on fulfillment or rejection.

```APIDOC
## register(callable $record, Application $app): void

### Description
After the `Illuminate\Http\Client\Factory` resolves, registers global HTTP client middleware: each request is timed (ms), and on fulfillment or rejection the record callback is invoked with `(RequestInterface $request, int $startedAt)`.

### Method
register

### Parameters
- **$record** (callable) - Required - The callback to invoke with the request and start time.
- **$app** (Application) - Required - The application instance.

### Return
void
```

--------------------------------

### Laravel\Pulse\Entry Constructor

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/entry-and-value.md

Creates a new Entry instance representing a numeric, aggregate-able metric.

```APIDOC
## Entry Constructor

### Description
Creates a new Entry instance with timestamp, type, key, and optional value.

### Method
Constructor

### Endpoint
`new Entry(int $timestamp, string $type, string $key, ?int $value = null)`

### Parameters
- **$timestamp** (int) - Required - Unix timestamp of the entry.
- **$type** (string) - Required - Entry type name (e.g. `slow_request`, `cache_hit`).
- **$key** (string) - Required - Bucket key — typically a JSON-encoded array of identifying fields or a user/queue identifier.
- **$value** (?int) - Optional - The numeric value (e.g. duration in milliseconds). Defaults to `null`.

### Request Example
```php
$entry = new Entry(
    timestamp: time(),
    type: 'slow_request',
    key: json_encode(['GET', '/checkout', 'App\Http\Controllers\CheckoutController@show']),
    value: 2450,
);
```

### Response
Returns an Entry instance with promoted public properties readable/writable directly.
```

--------------------------------

### Basic Pulse Recording

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Use the Pulse facade to record counts or set values in your application code.

```php
use Laravel\Pulse\Facades\Pulse;

Pulse::record('user_login', (string) $user->id)->count();

Pulse::set('system', 'web-1', json_encode([
    'cpu' => 42,
    'memory_used' => 2048,
    'memory_total' => 8192,
], flags: JSON_THROW_ON_ERROR));
```

--------------------------------

### pulse:check command signature and description

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/commands.md

Defines the pulse:check command with an optional --once flag. When set, the command takes a single snapshot and exits.

```php
public $signature = 'pulse:check {--once : Take a single snapshot}';
public $description = 'Take a snapshot of the current server\'s pulse';
```

--------------------------------

### StorageIngest Constructor

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/ingests.md

Constructor for the StorageIngest driver, which writes directly to the storage backend.

```php
public function __construct(protected Storage $storage)
```

--------------------------------

### rescue()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Executes a callback safely, catching any Throwable and invoking the configured exception handler.

```php
public function rescue(callable $callback): mixed
```

--------------------------------

### Servers recorder detection callbacks

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/types.md

Defines the expected types for the optional callbacks that can be passed to the Servers recorder to customize CPU and memory detection. The CPU callback returns an integer percentage, while the memory callback returns an array with total and used values.

```php
@var null|(callable(): int) $detectCpuUsing                    // returns CPU percent
@var null|(callable(): array{total: int, used: int}) $detectMemoryUsing
```

--------------------------------

### record(RequestInterface $request, int $startedAt): void

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorders-slow.md

Records a slow outgoing request entry when sampling passes, the URI is not ignored, and duration exceeds the threshold.

```APIDOC
## record(RequestInterface $request, int $startedAt): void

### Description
Records lazily when sampling passes, the normalized URI is not ignored, and duration is over threshold. Creates an Entry of type `slow_outgoing_request` with key = `json_encode([$method, $this->group($uri)])`, value = duration ms, and applies `->max()->count()`.

### Method
record

### Parameters
- **$request** (RequestInterface) - Required - The outgoing HTTP request.
- **$startedAt** (int) - Required - The timestamp when the request started.

### Return
void
```

--------------------------------

### rememberUser()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Stores the user key for attribution survival across logout events.

```php
public function rememberUser(Authenticatable $user): self
```

--------------------------------

### Embedding Pulse cards in Blade

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/livewire-components.md

Demonstrates how to use the x-pulse component to wrap and display various Pulse Livewire cards with custom layout attributes.

```blade
<x-pulse>
    <livewire:pulse.servers cols="full" />

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

    <livewire:pulse.slow-queries cols="8" />

    <livewire:pulse.exceptions cols="6" order-by="latest" />
</x-pulse>
```

--------------------------------

### RedisAdapter pipeline()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/support.md

Executes a closure within a Redis pipeline, ensuring the adapter methods are available inside the pipeline context.

```php
public function pipeline(callable $closure): array
```

--------------------------------

### Recorder ignore list configuration for Pulse dashboard path

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/endpoints.md

PHP array configuration for SlowRequests recorder ignore list. Includes regex patterns to exclude the Pulse dashboard path (using PULSE_PATH env, default 'pulse') and the /telescope path. Requests to Livewire's update route are attributed to the original controller path by the LivewireRoutes concern.

```php
Recorders\SlowRequests::class => [
    'ignore' => [
        '#^/'.env('PULSE_PATH', 'pulse').'$#',   // Pulse dashboard...
        '#^/telescope#',
    ],
],
```

--------------------------------

### shouldSample method

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorder-concerns.md

Returns a boolean indicating whether to sample the current event, based on the configured sample_rate. A rate of 1 samples every event; 0.1 samples approximately 10%.

```php
protected function shouldSample(): bool
```

--------------------------------

### rescue()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Executes a callback safely, catching any Throwable and invoking the configured exception handler.

```APIDOC
## rescue()

### Description
Runs the callback; on any Throwable it invokes the configured exception handler. Returns the callback's result or null when an exception was caught.

### Method
rescue()

### Signature
public function rescue(callable $callback): mixed

### Parameters
- **$callback** (callable(): TReturn) - Required - The callback to execute safely.

### Returns
- **mixed** - The callback's result, or null if an exception was caught.

```

--------------------------------

### user() method signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Sets a field resolver on the current ResolvesUsers instance via setFieldResolver(). Throws RuntimeException('The configured user resolver does not support setting user fields') when the resolved ResolvesUsers instance has no setFieldResolver method (src/Pulse.php:436).

```php
public function user(callable $callback): self
```

--------------------------------

### Entry Aggregate-flag Methods

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/entry-and-value.md

Methods to mark an Entry for aggregation. Each appends an aggregate marker and returns static for chaining.

```APIDOC
## Entry Aggregate-flag Methods

### Description
These methods mark the entry for aggregation. `count()` counts occurrences of the (type, key) pair; `min()`, `max()`, `sum()`, and `avg()` operate on the entry's value field.

### Methods
- `count(): static` - Marks for count aggregation.
- `min(): static` - Marks for minimum aggregation.
- `max(): static` - Marks for maximum aggregation.
- `sum(): static` - Marks for sum aggregation.
- `avg(): static` - Marks for average aggregation.

### Usage Example
```php
$entry = (new Entry(
    timestamp: time(),
    type: 'slow_request',
    key: json_encode(['GET', '/checkout', 'App\Http\Controllers\CheckoutController@show']),
    value: 2450,
))->max()->count();
```
```

--------------------------------

### Value constructor

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/entry-and-value.md

Constructor for the Value class, which takes a timestamp, type, key, and string value.

```php
public function __construct(
    public int $timestamp,
    public string $type,
    public string $key,
    public string $value,
)
```

--------------------------------

### css()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Dual-purpose method: with an argument, merges CSS paths into the dashboard list; without arguments, compiles and returns the aggregate CSS string.

```APIDOC
## css()

### Description
Called with one argument, merges the given CSS path(s) into the dashboard CSS list and returns $this. Called with no arguments, compiles and returns the aggregate CSS string.

### Method
css()

### Signature
public function css(string|Htmlable|array|null $css = null): string|self

### Parameters
- **$css** (string|Htmlable|array|null) - Optional - CSS path(s) or Htmlable to merge. If null, compiles and returns the CSS string.

### Returns
- **string|self** - When called with an argument, returns $this. When called with no arguments, returns the compiled CSS string.

### Throws
- **RuntimeException** - When a CSS path cannot be read.

```

--------------------------------

### Users::load() method signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/users.md

Eager-loads user data for the provided collection of keys.

```php
public function load(Collection $keys): self
```

--------------------------------

### Livewire Card query helper return types

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/types.md

Return types for the Livewire Card query helper methods, identical to the Storage contract. These methods retrieve values, graph data, aggregates, aggregate types, and aggregate totals from the storage.

```php
values(string $type, ?array $keys = null) : Collection<string, object{timestamp: int, key: string, value: string}>
```

```php
graph(array $types, string $aggregate) : Collection<string, Collection<string, Collection<string, int|null>>>
```

```php
aggregate(string $type, string|array $aggregates, ...) : Collection<int, mixed>
```

```php
aggregateTypes(string|array $types, string $aggregate, ...) : Collection<int, mixed>
```

```php
aggregateTotal(array|string $types, string $aggregate) : float|Collection<string, int>
```

--------------------------------

### pulse:clear command signature and description

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/commands.md

Defines the pulse:clear command (alias pulse:purge) with options --type=* to specify entry types and --force to skip the production confirmation prompt.

```php
public $signature = 'pulse:clear {--type=* : Only clear the specified type(s)}
                                     {--force : Force the operation to run when in production}';
public $description = 'Delete all Pulse data from storage';
```

--------------------------------

### PulseMigration getConnection method

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/support.md

Retrieves the database connection name configured for Pulse storage.

```php
public function getConnection(): ?string
```

--------------------------------

### defaultVendorCacheKeys()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Returns the default list of regular expressions used to ignore cache interactions from vendor packages.

```APIDOC
## defaultVendorCacheKeys()

### Description
Returns the default list of regular expressions applied to the CacheInteractions recorder's ignore list.

### Method
defaultVendorCacheKeys()

### Signature
public static function defaultVendorCacheKeys(): array

### Returns
- **array** - A list of regular expression strings.

```

--------------------------------

### DatabaseStorage store() method signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/database-storage.md

Signature of the store() method, which accepts a collection of Entry or Value instances to persist. It is a no-op for an empty collection and throws RuntimeException for unsupported database drivers.

```php
public function store(Collection $items): void   // Collection<int, Entry|Value>
```

--------------------------------

### register() method signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Registers recorders keyed by class name. Values can be false, a plain array, or an array with an 'enabled' key. Returns $this for chaining.

```php
public function register(array $recorders): self
```

--------------------------------

### shouldSampleDeterministically method

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorder-concerns.md

Deterministically decides whether to sample based on a seed, hashing it with md5 and comparing against the sample_rate. Used by the Queues recorder with the job UUID to ensure consistent sampling across related events.

```php
protected function shouldSampleDeterministically(string $seed): bool
```

--------------------------------

### digest() method signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Runs Ingest::digest($storage) (used to pull entries out of the Redis stream in the redis ingest driver) wrapped in ignore(). Returns the ingest driver's return value (entry count for RedisIngest).

```php
public function digest(): int
```

--------------------------------

### LivewireRoutes trait method

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorder-concerns.md

Returns a tuple of route path and action name. For Livewire update routes, it substitutes the component path from the snapshot and sets the via to 'via <path>'.

```php
protected function resolveRoutePath(Request $request): array   // array{0: string, 1: ?string}
```

--------------------------------

### pulse:work command signature and description

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/commands.md

Defines the pulse:work command with an optional --stop-when-empty flag. When set, the command returns SUCCESS after the first loop iteration instead of running forever.

```php
public $signature = 'pulse:work {--stop-when-empty : Stop when the stream is empty}';
public $description = 'Process incoming Pulse data from the ingest stream';
```

--------------------------------

### Card dehydrate method

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/livewire-card.md

A Livewire lifecycle method that registers component-specific stylesheets during non-Livewire requests.

```php
public function dehydrate()
```

--------------------------------

### defaultVendorCacheKeys()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Returns the default list of regular expressions used by the CacheInteractions recorder to ignore specific cache keys.

```php
public static function defaultVendorCacheKeys(): array
```

--------------------------------

### RedisAdapter xtrim()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/support.md

Trims a Redis stream based on the provided strategy and threshold.

```php
public function xtrim(string $key, string $strategy, string $strategyModifier, string|int $threshold): int
```

--------------------------------

### ConfiguresAfterResolving::afterResolving method signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/support.md

The method signature for the internal afterResolving trait used to guarantee configuration hooks run regardless of resolution order.

```php
public function afterResolving(Application $app, string $class, Closure $callback): void
```

--------------------------------

### RedisAdapter xrange()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/support.md

Retrieves a range of entries from a Redis stream.

```php
public function xrange(string $key, string $start, string $end, ?int $count = null): array
```

--------------------------------

### Card placeholder method

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/livewire-card.md

Returns the placeholder view used while a lazy-loaded card is rendering.

```php
public function placeholder(): Renderable
```

--------------------------------

### Aggregate query pattern for slow components

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/livewire-components.md

Shows the common render() method used by all five components. It uses $this->remember() to cache the result of $this->aggregate() with the type, aggregation functions, and orderBy-based column selection. The comment indicates that for Exceptions, the 'latest' orderBy maps to 'max'.

```php
public function render(): Renderable
{
    [$rows, $time, $runAt] = $this->remember(
        fn () => $this->aggregate(
            '<type>',
            ['max', 'count'],
            match ($this->orderBy) { 'count' => 'count', default => 'max' },  // 'latest' => 'max' for Exceptions
        )->map(fn ($row) => (object) [ /* decode $row->key via json_decode(..., JSON_THROW_ON_ERROR) */ ]),
        $this->orderBy,
    );
    // ...
}
```

--------------------------------

### SlowQueries listen property and record method signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorders-slow.md

The listen property listens to the QueryExecuted event, and the record method accepts that event. It records lazily when sampling passes, SQL is not ignored, and duration exceeds the threshold.

```php
public string $listen = QueryExecuted::class;

public function record(QueryExecuted $event): void
```

--------------------------------

### LegacyUsers::find()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/users.md

Looks up a user by key and returns the display object with name, extra, and avatar fields.

```APIDOC
## find()

### Description
Looks up a user by key and returns the display object with name, extra, and avatar fields.

### Method
find

### Parameters
- **$key** (int|string|null) - Required - The user key to look up.

### Returns
object - An object with properties: name (string), extra (string), avatar (string).
```

--------------------------------

### pulse:restart command signature and description

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/commands.md

Defines the pulse:restart command with no options. It writes the current time to the laravel:pulse:restart cache key to signal running work/check loops to stop.

```php
public $signature = 'pulse:restart';
public $description = 'Restart any running "work" and "check" commands';
```

--------------------------------

### recorders() method signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Returns a new Illuminate\Support\Collection<int, object> of the currently registered recorder instances.

```php
public function recorders(): Collection
```

--------------------------------

### Custom Ingest Driver Binding

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/ingests.md

Binding a custom ingest driver implementation to the container.

```php
use Laravel\Pulse\Contracts\Ingest;

app()->bind(Ingest::class, MyKafkaIngest::class);
```

--------------------------------

### Constructor signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

The constructor accepts the Laravel application container and initializes internal collections for filters, recorders, entries, and lazy resolvers. It sets $shouldRecord and $registersRoutes to true by default.

```php
public function __construct(protected Application $app)
```

--------------------------------

### Authorize handle method

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/middleware.md

The handle method processes incoming requests and checks the viewPulse ability, throwing an AuthorizationException on failure.

```php
public function handle(Request $request, Closure $next): mixed
```

--------------------------------

### Pulse::__construct

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Constructor for the Pulse class, initializing internal state and dependencies.

```APIDOC
## Constructor

```php
public function __construct(protected Application $app)
```

### Parameters
- **$app** (`Illuminate\Contracts\Foundation\Application`) - Required - The Laravel application container used to resolve config, events, ingest, storage, auth, and resolvers.

### Description
Initializes internal collections for filters, recorders, entries, and lazy resolvers. Sets `$shouldRecord` to `true` and `$registersRoutes` to `true`.
```

--------------------------------

### report()

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/pulse.md

Reports an exception by dispatching an ExceptionReported event wrapped in rescue(). Returns the recorder instance for chaining.

```APIDOC
## report(Throwable $e): self

### Description
Dispatches a `Laravel\Pulse\Events\ExceptionReported` event wrapped in `rescue()`. Returns `$this`.

### Method
report

### Signature
```php
public function report(Throwable $e): self
```

### Parameters
- **$e** (`Throwable`) - Required - The exception to report.

### Returns
- `self` - The recorder instance for chaining.
```

--------------------------------

### Servers recorder event listener and record method signature

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/recorders-counters.md

The Servers recorder listens to the SharedBeat event and records CPU, memory, and storage metrics on each beat, throttled to one snapshot per 15 seconds.

```php
public string $listen = SharedBeat::class;

public function record(SharedBeat $event): void
```

--------------------------------

### Define custom CSS for Livewire card

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/livewire-card.md

The css() method is a hook that allows subclasses to include extra stylesheets.

```php
protected function css()
```

--------------------------------

### NullIngest Methods

Source: https://github.com/laravel/pulse/blob/1.x/_autodocs/api-reference/ingests.md

No-op methods for the NullIngest driver, typically used in tests.

```php
public function ingest(Collection $items): void   // does nothing
public function digest(Storage $storage): int     // returns 0
public function trim(): void                      // does nothing
```
Tokens:
Raw