GitXplorerGitXplorer
i

healthCheck

public
0 stars
0 forks
0 issues

Commits

List of commits on branch master.
Unverified
016ce4ad360969174b683142579e1aad54008045

update readme

iicyxp committed 7 years ago
Unverified
9388b65b6460425388936cd5721a1a236aca501d

update namespace

iicyxp committed 7 years ago
Unverified
0431296ca6162ef0a47916e68b9472b5f2615155

adjust composer namespace

iicyxp committed 7 years ago
Unverified
1a9c61804284d6847ee354d82d3b10f14e981dc0

add namespace

iicyxp committed 7 years ago
Unverified
6c19d1bce14a153de0e2cdd76d56cd58a3ee0646

update readme

iicyxp committed 7 years ago
Unverified
cfd983e88585d284dc8a285587f99d9c89e30040

update composer.json

iicyxp committed 7 years ago

README

The README file for this repository.

HealthCheck

Allows you to easily write healthchecks for your application and display a simple, aggregated report so you can quickly diagnose whether and why your app is having trouble (or whether you can blame someone else). You can also monitor your healthchecks with nagios, zabbix, etc.

Build Status

Wait, what's a healthcheck?

Healthchecks are a great way to test system health and connectivity to other services. For example, you can verify connectivity to memcache or mysql, that your app can read / write to certain files, or that your API key for a third-party service is still working.

Installation

You can install this into your project using composer. Create a composer.json file in the root of your project and add the following:

{
    "require": {
        "php": ">=5.4.0",
        "icyboy/health-check": "~1.0"
    }
}

Run composer install, include vendor/autoload.php, and you're off to the races!

Example Usage

Checks

use Icyboy\HealthCheck\HealthManager;
use Icyboy\HealthCheck\HealthException;

$hc = new HealthManager();

$hc->addCheck('info', function(){
    return "response extra message";
});

$hc->addCheck('pass', function() {
    return true;
});

$hc->addCheck('fail', function() {
    return false;
});

$config["version"] = 123;
$hc->addCheck('xxx', function() use ($config) {
    if ($config["version"] == "123") {
        return $config;
    } else {
        throw new HealthException("something was wrong");
    }
});

echo json_encode($hc->check());