README

Introduction

Laravel Pulse GraphQL is a powerful monitoring package designed for Laravel applications that use GraphQL. Built specifically for applications utilizing the rebing/graphql-laravel package, it integrates with Laravel Pulse to track and measure GraphQL request performance. This package provides developers with valuable insights into request timing and response counts, helping to maintain and optimize the performance of GraphQL endpoints in Laravel applications.

Installation

Install the package via Composer:

composer require larassn/laravel-pulse-graphql

Next, you need to publish the Pulse configuration file. Run the following command:

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

This will create a pulse.php configuration file in the config directory. For more details on configuring Pulse, you can refer to the Pulse configuration.

After publishing the configuration, add the QueryRecorder to the recorders array in the pulse.php configuration file:

return [
    // ...

    'recorders' => [
        // Other recorders...
        \LaraSsn\LaravelPulseGraphql\Recorder\QueryRecorder::class => [], 
    ]
];

Then, add the GraphQL card to the Pulse dashboard:

<livewire:pulse.graphql cols="6"/>

For more information on customizing the Pulse dashboard, refer to the dashboard customization.

Usage

Once installed, Laravel Pulse GraphQL will automatically start recording GraphQL request data, which you can monitor on the Pulse dashboard. You can customize its configuration in pulse.php to suit your application's specific needs.

License

The MIT License (MIT). Please see License File for more information.