phprofiler/laravel-phprofiler

Laravel middleware to capture PHProfiler profiling data

dev-main 2024-06-12 18:14 UTC

Requires

• php: ^8.0
• ext-curl: *
• ext-json: *
• guzzlehttp/guzzle: ^7.0
• illuminate/http: ^9.0|^10.0|^11.0
• illuminate/routing: ^9.0|^10.0|^11.0
• illuminate/support: ^9.0|^10.0|^11.0

Apache-2.0

README

Laravel middleware to capture PHProfiler profiling data. This package is compatible with Laravel 9, 10, and 11.

Installation

You can install the package via composer:

composer require phprofiler/laravel-phprofiler

If you are using a version of Laravel that does not automatically discover packages, you will need to manually add the service provider in config/app.php:

'providers' => [
    // Other Service Providers
    PHProfiler\PHProfilerServiceProvider::class,
],

Publishing the Configuration

To publish the configuration file, run the following command:

php artisan vendor:publish --provider="PHProfiler\PHProfilerServiceProvider"

This will publish the configuration file to config/phprofiler.php.

Configuration

Add the following to your .env file:

PHPROFILER_ENABLED=true
PHPROFILER_DSN={Get your DSN from the PHProfiler UI}

You can customize the configuration by editing the config/phprofiler.php file.

Usage

Once the package is installed and configured, the middleware will automatically capture PHProfiler profiling data and send it to the configured endpoint.

The middleware is automatically registered and added to the web middleware group. If you need to add it to a specific route or group, you can do so in your app/Http/Kernel.php file:

protected $middleware = [
    // ...
    \PHProfiler\PHProfilerMiddleware::class,
];

License

The Apache 2.0 License (Apache-2.0). Please see License File for more information.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Issues

If you encounter any issues, please create a new issue in the GitHub Issue Tracker.