sa/web-benchmark

Package for benchmarking web pages

dev-master 2017-10-05 17:48 UTC

Requires

• phpmailer/phpmailer: ^6.0

MIT

README

Installation

composer require "sa/web-benchmark":"dev-master"

Configuration

Configuration file: Configs/app.php

<?php

return [
    'mail' => [
        'driver' => 'smtp',
        'smtp' => [
            // SMTP configs
            'host' => 'smtp.mailtrap.io',
            'port' => 2525,
            'username' => '',
            'password' => '',
        ],
        'from' => [
            // Sender 
            'email' => '[e-mail]',
            'name' => 'Web Benchmark',
        ],
        'to' => [
            // Send reports to
            '[e-mail]'
        ],
    ],
    'sms' => [
        'api_key' => 'API_KEY_EXAMPLE',
        'from' => 'Web Benchmark',
    ]
];

Usage

Creating instance

use Sa\WebBenchmark\WebBenchmark;
use Sa\WebBenchmark\Exceptions\InvalidArgumentException;

$url = "https://www.google.com";

$competitors = [
    "https://laravel.com",
    "https://symfony.com",
    "https://github.com",
];

try {
    $webBenchmark = new WebBenchmark($url, $competitors);
} catch (InvalidArgumentException $e) {}

Create event manager

use Sa\WebBenchmark\EventManager;
use Sa\WebBenchmark\Listeners\NotifyViaEmailEventListener;
use Sa\WebBenchmark\Listeners\NotifyViaSmsEventListener;


$eventManager = new EventManager();
$eventManager->attach(NotFastestEvent::class, new NotifyViaEmailEventListener(['[e-mail]']));
$eventManager->attach(TwoTimesSlowestEvent::class, new NotifyViaSmsEventListener(['123456789']));

$webBenchmark->setEventManager($eventManager);

Available event managers:

• NotifyViaEmailEventListener - Send email, if benchmarked website is loaded slower than at least one of the competitors
• NotifyViaSmsEventListener - Send SMS, if benchmarked website is loaded twice as slow as at least one of the competitors

Run benchmark

try {
    $webBenchmark->run();
} catch (\Exception $e) {
}

Output data

use Sa\WebBenchmark\Outputs\JsonOutput;

$webBenchmark->setOutput(new JsonOutput);

$json = $webBenchmark->output();

Available output:

• JsonOutput
• HtmlOutput
• ConsoleOutput
• FileOutput
• PlainTextOutput

Example

Create index.php

<?php

require "../vendor/autoload.php";

use Sa\WebBenchmark\Outputs\ConsoleOutput;
use Sa\WebBenchmark\WebBenchmark;

/**
 * @param $resource
 * @param array $competitors
 */
function main($resource, array $competitors)
{
    $webBenchmark = new WebBenchmark($resource, $competitors, new ConsoleOutput);

    $webBenchmark->run();

    echo $webBenchmark->output();
}

main("https://www.google.com", ["https://laravel.com", "https://github.com", "https://www.facebook.com"]);

$ php index.php