hardtyz/yii2-health

Yii2 multipoint health check

0.0.2 2018-08-07 12:48 UTC

Requires

• php: >=5.4.0
• yiisoft/yii2: 2.0.*
• yiisoft/yii2-composer: 2.0.*

MIT

• Anon

• check
• health
• status
• yii2
• yii2-health
• health-status

README

1. Instalation

The preferred way to install this extension is through composer.

and add next lines to composer.json

    "repositories": [
        {
            "url": "https://bitbucket.org/HardTYZ/yii2-health",
            "type": "git"
        }
    ]

and add line to require section of composer.json

"hardtyz/yii2-health": "*"

Usage

Example configuration

Just simply add to your config in modules, you need to define your checks in "check" array.

...
   'modules'   => [
        'health' => [
            'class'  => 'hardtyz\health\Module',
            'check' => [
                "TcpCheck" => [
                    "type" => "tcp",                    // type tcp
                    "host" => "localhost",              // tcp host or ip adress
                    "port" => 80,                       // tcp port
                    "name" => "TcpCheck"                // service name
                ],
                "HttpCheck" => [
                    "type" => "http",                   // type http
                    "host" => "http://localhost",       // http or https host
                    "name" => "HttpCheck"               // service name
                ],
                "DataBaseCheck" => [
                    "type" => "db",                     // type database
                    "db" => "db",                       // name of database profile
                    "name" => "DB"                      // service name
                ],
            ],
        ],
    ],
...