README

Requests Graph for Laravel Pulse

Credits to Aaron Francis for his Pulse tutorial.

This is a Laravel Pulse package that adds a graph showing the latest requests.

Customizable requests status to be shown

Installation

You can install the package via composer:

composer require paulo-hortelan/requests-graph-pulse

Register the recorder

Add the RequestsGraphRecorder inside config/pulse.php. (If you don't have this file make sure you have published the config file of Larave Pulse using php artisan vendor:publish --tag=pulse-config)

return [
    // ...

    'recorders' => [
        // Existing recorders...

        \PauloHortelan\RequestsGraphPulse\Recorders\RequestsGraphRecorder::class => [
            'enabled' => env('PULSE_REQUESTS_GRAPH_ENABLED', true),
            'sample_rate' => env('PULSE_REQUESTS_GRAPH_SAMPLE_RATE', 1),
            'record_informational' => env('PULSE_REQUESTS_GRAPH_RECORD_INFORMATIONAL', false),
            'record_successful' => env('PULSE_REQUESTS_GRAPH_RECORD_SUCCESSFUL', true),
            'record_redirection' => env('PULSE_REQUESTS_GRAPH_RECORD_REDIRECTION', false),
            'record_client_error' => env('PULSE_REQUESTS_GRAPH_RECORD_CLIENT_ERROR', true),
            'record_server_error' => env('PULSE_REQUESTS_GRAPH_RECORD_SERVER_ERROR', true),
            'ignore' => [
                '#^/pulse$#', // Pulse dashboard...
            ],            
        ], 
    ]
]

Add to your dashboard

To add the card to the Pulse dashboard, you must first publish the vendor view.

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

Then, you can modify the dashboard.blade.php file and add the requests-graph livewire template:

<livewire:requests-graph cols="6" />

Testing

composer test

TODO

Give the option to record the endpoint for each request
Filter the graph requests for selected endpoint

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

paulo-hortelan / requests-graph-pulse

Maintainers

Details