Repository files navigation

Add Server-Timing header information from within your Laravel apps.

You can install the package via composer:

composer require matchory/laravel-server-timing

To add server-timing header information, you need to add the\Matchory\ServerTiming\Middleware\ServerTimingMiddleware::class, middleware to your HTTP Kernel. In order to get themost 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:

To enable database timing, you have to options built-in that you can enable via the configuration file:

• measure_database: Measure total database timing. This will track the total time spent in database queries.
• measure_queries: Measure database timing per query. This will track the time spent in each individual query and addthem as individual metrics.

Note: If you have many queries, this may result in significantly large headers. Some web servers, like nginx, willbail if the headers grow too large. Review the manual for your web server to adjust these limits, if necessary.

If you want to provide additional measurements, you can use the start and stop methods. If you do not explicitly stop ameasured event, the event will automatically be stopped once the middleware receives your response. This can be usefulif you want to measure the time your Blade views take to compile.

ServerTiming::start('Running expensive task');// do somethingServerTiming::stop('Running expensive task');

If you already know the exact time that you want to set as the measured time, you can use thesetDuration method.The duration should be set as milliseconds:

ServerTiming::setDuration('Running expensive task',1_200);

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.

The configuration file could be published using:php artisan vendor:publish --tag=server-timing-config

You can disable the middleware changing thetiming.enabled configuration to false.

ServerTiming::addMetric("User:{$user->id}");

Please seeCHANGELOG for more information on what has changed recently.

Please seeCONTRIBUTING for details.

To run unit tests, use the following command:

composertest

You can also run the type checks using the following command:

composer analyze

If you discover any security related issues, please emailmarcel@beyondco.de instead of using the issue tracker.

• Moritz Friedrich
• Marcel Pociot
• All Contributors

The MIT License (MIT). Please seeLicense File for more information.