jordanbrauer/cronitor-php

A small wrapper object for Cronitor.io cron job monitoring service.

0.1.1 2017-05-26 02:51 UTC

Requires

• php: >=7.0

Requires (Dev)

• phpunit/phpunit: ^6.1

MIT

• Jordan Brauer

README

A small wrapper object for Cronitor.io cron job monitoring service.

Downloading & Installing

Composer

$ composer require jordanbrauer/cronitor-php

Setup

require_once "vendor/autoload.php";

use \Cronitor\Monitor;

Minimal

$cronitor = new Monitor("monitor_id");

Extended

$cronitor = new Monitor("monitor_id", [
  "base_url" => "https://cronitor.link",
  "auth_key" => "your_private_secret_confidential_auth_key",
]);

Usage

run()

run ([ string $message ])

$cronitor->run(); // plain run ping
$cronitor->run("Hello Cronitor!"); // run ping with message

complete()

complete ([ string $message ])

$cronitor->complete(); // plain complete ping
$cronitor->complete("Goodbye Cronitor!"); // complete ping with message

fail()

fail ([ string $message ])

$cronitor->fail(); // plain fail ping
$cronitor->fail("Damn Cronitor!"); // fail ping with message

pause()

pause (integer $duration)

$cronitor->pause(1); // pause for 1 hour

resume()

resume ()

$cronitor->resume(); // resume monitoring