Laravel-Benchmark

Adds a Benchmark helper to your project, to get

exact time
elapsed time
RAM usage
queries ran by Eloquent

between checkpoints.

Installation

composer require janiaje/benchmark

If Laravel version < 5.5, you have to manually include the following line in your config/app.php:

Janiaje\Benchmark\Provider::class,

Usage (basics)

Use the 'benchmark()' helper to easily access to the Benchmark class

benchmark()

Add checkpoints:

benchmark()->checkpoint();

Get the elapsed time between the first and the last checkpoint

$elapsedTime = benchmark()->getElapsedTime();

Get the maximum amount RAM (in bytes) allocated by PHP in the checkpoints

$ramUsage = benchmark()->getPeakRamUsage();

Get the checkpoints

$checkpoints = benchmark()->getCheckpoints();

Dump the checkpoints

benchmark()->dump();

DD the checkpoints:

benchmark()->dd();

Set the output format for the checkpoints:

benchmark()->setOutputFormat(ArrayFormat::class);
benchmark()->setOutputFormat(JsonFormat::class);

The 2 options mentioned above are available by default. You can override them or make your own, but make sure it implements the \Janiaje\Benchmark\OutputFormats\OutputFormat interface.

Example of ArrayFormat::class output:

Collection {#275 ▼
  #items: array:2 [▼
    0 => array:6 [▼
      "id" => "#1"
      "name" => null
      "group" => null
      "time" => Carbon @1521101210 {#272 ▶}
      "timeDifference" => null
      "ram" => 6291456
      "queries" => []
    ]
    1 => array:6 [▼
      "id" => "#2"
      "name" => null
      "group" => null
      "time" => Carbon @1521101211 {#270 ▶}
      "timeDifference" => DateInterval {#277 ▶}
      "ram" => 6291456
      "queries" => array:1 [▼
        0 => {#279 ▼
          +"query": "SELECT * FROM users WHERE email = ?"
          +"bindings": array:1 [▼
            0 => "[email protected]"
          ]
          +"time": 1.15
        }
      ]
    ]
  ]
}

Usage (additional options)

Naming checkpoints

This name will show up in the results so it will be easier to find a specific checkpoint.

benchmark()->checkpoint("After expensive calculation");

    1 => array:6 [▼
      "id" => "#2"
      "name" => "After expensive calculation"
      "group" => null
      "time" => Carbon @1521101211 {#270 ▶}

Grouping checkpoints

Creating a checkpoint with a group:

benchmark()->checkpointWithGroup("File generation");

This group will show up in the results:

    1 => array:6 [▼
      "id" => "#2"
      "name" => "After expensive calculation"
      "group" => "File generation"
      "time" => Carbon @1521101211 {#270 ▶}

You can filter the results by groups:

benchmark()->getCheckpointsByGroup("File generation");

Deleting checkpoints

Delete all checkpoints:

benchmark()->deleteAllCheckpoints();

Delete checkoints by group:

benchmark()->deleteCheckpoints("File generation");

Delete checkoints by id:

$checkpoint = benchmark()->checkpoint();
benchmark()->deleteCheckpoint($checkpoint->getId();

If you dont want to delete them, you can always create your own Benchmark instances and collect everythign sepearately:

$benchmark1 = new Benchmark;
$benchmark1->checkpoint();
$benchmark1->getAllCheckpoints();

$benchmark2 = new Benchmark;
$benchmark2->checkpoint();
$benchmark2->getAllCheckpoints();

janiaje / laravel-benchmark Goto Github PK