Laravel Server Timings
Add Server-Timing header information from within your Laravel apps.
Installation
You can install the package via composer:
composer require beyondcode/laravel-server-timing
Usage
To 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.
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:
Adding additional measurements
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.
ServerTiming::start('Running expensive task');
// do something
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);
});
Adding textual information
You can also use the Server-Timing middleware to only set textual information without providing a duration.
Publishing configuration file
The configuration file could be published using: php artisan vendor:publish --tag=server-timing-config
You can disable the middleware changing the timing.enabled configuration to false.
ServerTiming::addMetric('User: '.$user->id);
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
![[Feature]](https://avatars.githubusercontent.com/u/6986565?v=4)
1 Nov 25, 2021
2 Oct 7, 2022
3 Dec 8, 2021
45 Dec 27, 2022
8 May 17, 2022
20 Oct 20, 2022
2 Feb 16, 2022
10 Dec 1, 2022
1.7k Dec 29, 2022
12 Jan 10, 2022
3 Dec 3, 2022
260 Dec 29, 2022
121 Nov 18, 2022
35 Dec 13, 2022
55 Oct 28, 2022
269 Dec 21, 2022
227 Dec 25, 2022