Add Server-Timing header information from within your Laravel apps.
You can install the package via composer:
composer require beyondcode/laravel-server-timingTo add server-timing header information, you need to add the \BeyondCode\ServerTiming\Middleware\ServerTimingMiddleware::class, middleware to your HTTP Kernel.
In order to get the most accurate results, put the middleware as the first one to load in the middleware stack.
bootstrap/app.php
return Application::configure(basePath: dirname(__DIR__))
// ...
->withMiddleware(function (Middleware $middleware) {
$middleware->prepend(\BeyondCode\ServerTiming\Middleware\ServerTimingMiddleware::class);
})
// ...
->create();app/Http/Kernel.php
class Kernel extends HttpKernel
{
protected $middleware = [
\BeyondCode\ServerTiming\Middleware\ServerTimingMiddleware::class,
// ...
];By default, the middleware measures only three things, to keep it as light-weight as possible:
- Bootstrap (time before the middleware gets called)
- Application time (time to get a response within the app)
- Total (total time before sending out the response)
Once the package is successfully installed, you can see your timing information in the developer tools of your browser. Here's an example from Chrome:
If you want to provide additional measurements, you can use the start and stop methods. If you do not explicitly stop a measured event, the event will automatically be stopped once the middleware receives your response. This can be useful if you want to measure the time your Blade views take to compile.
use BeyondCode\ServerTiming\Facades\ServerTiming;
ServerTiming::start('Running expensive task');
// Take a nap
sleep(5);
ServerTiming::stop('Running expensive task');
If you already know the exact time that you want to set as the measured time, you can use the setDuration method. The duration should be set as milliseconds:
ServerTiming::setDuration('Running expensive task', 1200);In addition to providing milliseconds as the duration, you can also pass a callable that will be measured instead:
ServerTiming::setDuration('Running expensive task', function() {
sleep(5);
});You can also use the Server-Timing middleware to only set textual information without providing a duration.
ServerTiming::addMetric('User: '.$user->id);The configuration file could be published using:
php artisan vendor:publish --tag=server-timing-config
You can disable the middleware by changing the timing.enabled configuration to false or adding SERVER_TIMING_ENABLED=false to your .env file.
composer testPlease see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email marcel@beyondco.de instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.