The Laravel N+1 query detector helps you increase your application's performance by reducing the number of queries it executed. This package will monitor your queries while you develop your application and notify you when you should add eager loading (N+1 queries).
You can install the package via composer:
composer require beyondcode/laravel-query-detector --devThe package will automatically register itself.
The query monitor will be automatically activated, if you are in debug mode.
By default, this package will display an alert message to notify you about found N+1 queries in the current request.
If you rather want this information to be written to your laravel.log file, you can publish the configuration and change the output behaviour.
You can publish the package's configuration using this command:
php artisan vendor:publish --provider=BeyondCode\\QueryDetector\\QueryDetectorServiceProviderThis will publish the querydetector.php file in your config directory with the following contents:
<?php
return [
/*
* Enable or disable the query detection.
* If this is set to "null", the app.debug config value will be used.
*/
'enabled' => env('QUERY_DETECTOR_ENABLED', null),
/*
* Threshold level for the N+1 query detection. If a relation query will be
* executed more then this amount, the detector will notify you about it.
*/
'threshold' => 1,
/*
* Here you can whitelist model relations.
*
* Right now, you need to define the model relation both as the class name and the attribute name on the model.
* So if an "Author" model would have a "posts" relation that points to a "Post" class, you need to add both
* the "posts" attribute and the "Post::class", since the relation can get resolved in multiple ways.
*/
'except' => [
//Author::class => [
// Post::class,
// 'posts',
//]
],
/*
* Define the output format that you want to use.
* Available options are:
*
* Alert:
* Displays an alert on the website
* \BeyondCode\QueryDetector\Outputs\Alert::class
*
* Log:
* Writes the N+1 queries into the Laravel.log file
* \BeyondCode\QueryDetector\Outputs\Log::class
*/
'output' => \BeyondCode\QueryDetector\Outputs\Alert::class,
];composer testPlease see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.