Skip to content

Latest commit

 

History

History
121 lines (89 loc) · 4.39 KB

README.md

File metadata and controls

121 lines (89 loc) · 4.39 KB
Raw

Laravel Server Timings

Latest Version on Packagist Build Status Total Downloads Laravel Octane Compatible

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

Installation

You can install the package via composer:

composer require matchory/laravel-server-timing

Usage

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 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: image

Enabling automatic database timing

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 add them as individual metrics.

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

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', 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);
});

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}");

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Testing

To run unit tests, use the following command:

composer test

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

composer analyze

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.