Giter VIP home page Giter VIP logo

laravel-server-timing's Introduction

Laravel Server Timings

Latest Version on Packagist Build Status Total Downloads

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

โš ๏ธ Fork of beyondcode/laravel-server-timing

Installation

You can install the package via composer:

composer require machatschek/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:

image

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.

ServerTiming::addMessage('User: '.$user->id);

Disabling

To disable, add SERVER_TIMING=false to your .env file.

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.

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.

laravel-server-timing's People

Contributors

adamhopkinson avatar binaryk avatar drbyte avatar intellow avatar mmachatschek avatar mpociot avatar sarfraznawaz2005 avatar spekulatius avatar sschlein avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.