perfbase/laravel

A Laravel extension for the Perfbase profiling tool.

v0.2.0 2025-04-10 22:19 UTC

Requires

• php: >=7.4 <8.5
• ext-json: *
• ext-zlib: *
• guzzlehttp/guzzle: ^7.0
• illuminate/support: ^8.0|^9.0|^10.0|^11.0|^12.0
• perfbase/php-sdk: v0.2.0

Requires (Dev)

• mockery/mockery: ^1.6
• orchestra/testbench: ^6
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^9

Apache-2.0

• Ben Poulson

• profiling
• laravel
• Perfbase

README

Laravel integration for Perfbase - the PHP profiling service that helps you understand and optimize your application's performance.

Installation

1. Install package to your laravel Project

composer require perfbase/laravel

1. Publish configuration

php artisan vendor:publish --tag="perfbase-config"

1. Add basic Perfbase config to your .env file

PERFBASE_ENABLED=true
PERFBASE_API_KEY=your_key_here
PERFBASE_SAMPLE_RATE=1.0

1. Add our to your middleware stack

\Perfbase\Laravel\Middleware\PerfbaseMiddleware::class

1. Start profiling your application!

Sending mode - local buffering

If you'd like to buffer data before sending it to Perfbase, you can configure the PERFBASE_SENDING_MODE option. The available sending mode values are:

1. sync: Sends data immediately without buffering.
2. database: Stores data in files before sending it to Perfbase.
3. file: Caches data in a database table before sending.

Available Commands

# Send locally buffered traces to the API, then removes your locally buffered copy.
# Consider running this command in a scheduled cron job.
php artisan perfbase:sync

# Delete all locally buffered traces. (Useful for debugging, or destruction)
php artisan perfbase:clear

Requirements

• PHP 7.4 or higher
• Laravel 8.0 or higher
• Perfbase PHP extension

Contributing

Please see CONTRIBUTING.md for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

License

The Apache License Version 2.0. Please see License File for more information.