> ## Documentation Index > Fetch the complete documentation index at: https://kawax.biz/llms.txt > Use this file to discover all available pages before exploring further. # Laravel Pulse > Learn how to install and configure Laravel Pulse for real-time application monitoring. Covers recorders, sampling, dashboard customization, and custom cards. ## What is Laravel Pulse [Laravel Pulse](https://github.com/laravel/pulse) delivers at-a-glance insights into your application's performance and usage. With Pulse, you can track down bottlenecks like slow jobs and endpoints, find your most active users, and more. ### Pulse vs Telescope | Feature | Laravel Pulse | Laravel Telescope | | -------- | ------------------------------------------------- | ------------------------------------------------ | | Purpose | Aggregate trends and metrics across the whole app | Deep debugging of individual requests and events | | Data | Pre-aggregated metrics | Per-event logs | | Best for | Production monitoring | Development and staging debugging | For in-depth debugging of individual events, check out [Laravel Telescope](/en/blog/telescope-introduction). ### Data flow ```mermaid theme={null} flowchart LR A["Laravel App"] -->|Detects events| B["Recorders"] B -->|Records entries| C["Database
(Pulse tables)"] C -->|Aggregates and displays| D["Dashboard
/pulse"] E["pulse:check
daemon"] -->|Server metrics| C ``` *** ## Installation Pulse's first-party storage implementation requires a MySQL, MariaDB, or PostgreSQL database. If you are using a different database engine, you will need a separate MySQL, MariaDB, or PostgreSQL database for your Pulse data. Install Pulse via Composer. ```shell theme={null} composer require laravel/pulse ``` Publish the Pulse service provider assets. ```shell theme={null} php artisan vendor:publish --provider="Laravel\Pulse\PulseServiceProvider" ``` Create the tables needed to store Pulse data. ```shell theme={null} php artisan migrate ``` Once migrations have run, access the Pulse dashboard at the `/pulse` route. ### Publishing the configuration file You can publish the configuration file separately to customize recorders and advanced options. ```shell theme={null} php artisan vendor:publish --tag=pulse-config ``` *** ## Dashboard access ### Authorization By default, the Pulse dashboard is only accessible in the `local` environment. For production, configure the `viewPulse` authorization gate in your `AppServiceProvider`. ```php theme={null} use App\Models\User; use Illuminate\Support\Facades\Gate; /** * Bootstrap any application services. */ public function boot(): void { Gate::define('viewPulse', function (User $user) { return $user->isAdmin(); }); } ``` ### Customizing the dashboard Publish the dashboard view to customize cards and layout. ```shell theme={null} php artisan vendor:publish --tag=pulse-dashboard ``` The published file is at `resources/views/vendor/pulse/dashboard.blade.php`. The dashboard is powered by [Livewire](https://livewire.laravel.com/), so no JavaScript rebuild is required for customization. ```blade theme={null} {{-- Span the full screen width --}} ... {{-- Change the column count --}} ... ``` Control each card's size and position with `cols` and `rows` props. ```blade theme={null} ``` *** ## Recorders Recorders capture entries from your application and write them to the Pulse database. Configure them in the `recorders` section of `config/pulse.php`. ### Requests and slow requests The `Requests` recorder captures information about incoming requests. Configure the slow route threshold (default: 1000ms), sample rate, and ignored paths. ```php theme={null} Recorders\SlowRequests::class => [ // ... 'threshold' => [ '#^/admin/#' => 5000, 'default' => env('PULSE_SLOW_REQUESTS_THRESHOLD', 1000), ], ], ``` ### Slow jobs The `SlowJobs` recorder captures jobs that exceed the configured threshold (default: 1000ms). You can set per-job thresholds using regular expressions. ```php theme={null} Recorders\SlowJobs::class => [ // ... 'threshold' => [ '#^App\\Jobs\\GenerateYearlyReports$#' => 5000, 'default' => env('PULSE_SLOW_JOBS_THRESHOLD', 1000), ], ], ``` ### Exceptions The `Exceptions` recorder captures reportable exceptions occurring in your application. Exceptions are grouped by class and the location where they occurred. ### Cache The `CacheInteractions` recorder captures cache hits and misses. You can normalize similar keys into groups using regular expressions. ```php theme={null} Recorders\CacheInteractions::class => [ // ... 'groups' => [ '/:\d+/' => ':*', ], ], ``` ### Queues The `Queues` recorder tracks queue throughput: queued, processing, processed, released, and failed jobs. ### Servers The `Servers` recorder captures CPU, memory, and storage usage of your servers. You must run the `pulse:check` command on each server you want to monitor. ```shell theme={null} php artisan pulse:check ``` By default, Pulse uses PHP's `gethostname()` as the server name. Override it with an environment variable. ```ini theme={null} PULSE_SERVER_NAME=load-balancer ``` ### Users The `UserRequests` and `UserJobs` recorders capture which users are making requests and dispatching jobs. This data appears in the Application Usage card. ### Redis ingest For high-traffic applications, you can send entries to a Redis stream and process them asynchronously. ```ini theme={null} PULSE_INGEST_DRIVER=redis ``` When using Redis ingest, run the `pulse:work` command to move entries from Redis into the database. ```shell theme={null} php artisan pulse:work ``` *** ## Sampling For high-traffic applications, capturing every event can result in millions of database rows. Enable **sampling** to record only a fraction of events. The dashboard scales values up and marks approximations with `~`. ```php theme={null} // config/pulse.php Recorders\UserRequests::class => [ 'sample_rate' => 0.1, // record ~10% of requests ], ``` The more entries you have for a metric, the lower you can set the sample rate while maintaining accuracy. *** ## Environment variables Key configuration values can be set via environment variables. | Variable | Description | Default | | ------------------------------- | ---------------------------------- | --------------------- | | `PULSE_ENABLED` | Enable or disable Pulse | `true` | | `PULSE_DB_CONNECTION` | Database connection for Pulse data | App default | | `PULSE_INGEST_DRIVER` | Ingest driver (`redis`, etc.) | `storage` | | `PULSE_SERVER_NAME` | Server display name | `gethostname()` value | | `PULSE_SLOW_REQUESTS_THRESHOLD` | Slow request threshold (ms) | `1000` | | `PULSE_SLOW_JOBS_THRESHOLD` | Slow job threshold (ms) | `1000` | | `PULSE_SLOW_QUERIES_THRESHOLD` | Slow query threshold (ms) | `1000` | *** ## Custom cards You can build custom Pulse cards to display data specific to your application. Cards are implemented as [Livewire](https://livewire.laravel.com/) components. ```php theme={null} 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'); } } ``` Use Pulse's Blade components in your card view for a consistent look and feel. ```blade theme={null} ... ... ``` Capture custom data with the `Pulse::record` method. ```php theme={null} use Laravel\Pulse\Facades\Pulse; Pulse::record('user_sale', $user->id, $sale->amount) ->sum() ->count(); ``` Once your component and template are defined, include the card in your dashboard view. ```blade theme={null} ... ``` *** ## Summary | Goal | How | | ----------------------------- | ----------------------------------------- | | Install Pulse | `composer require laravel/pulse` | | Access the dashboard | `/pulse` route | | Restrict access in production | Define the `viewPulse` gate | | Enable server monitoring | Run `php artisan pulse:check` as a daemon | | Reduce database load | Set `sample_rate` on recorders | ## Next steps Learn how Laravel handles and reports exceptions. Configure and use Laravel's logging system. ## Related topics - [Laravel Reverb](/en/reverb.md) - [Laravel Pennant](/en/pennant.md) - [Laravel Telescope: Practical Dev Techniques](/en/blog/telescope-introduction.md) - [Getting started with Laravel Nightwatch](/en/blog/nightwatch-introduction.md) - [Laravel Sentinel — Repository investigation and ecosystem positioning](/en/blog/sentinel-introduction.md)