Skeleton v2

Healthcheck

A Healthcheck funkcionalitás egy önálló modulon keresztül működik. Bekapcsolásához szükséges egy blokk a settings.php-ban a moduloknál:

<?php
    'HealthCheck'  => [
    'enabled' => true,
    'weight'  => 1, // Module load order
],
?>

A helyes működéshez szükséges a Settings-ben a gyökér szintem az appname kulcs:

<?php
return [
    'settings' => [
        'displayErrorDetails' => true,
        'debug' => true,
        'appname' => 'Skeleton',

Ha ez megvan, akkor hozzá kell adni egy önálló konfigurációs blokkot a gyökér szintre (middleware, settings-el azonos szinre):

<?php
    'healthcheck' => [
        'enabled' => true,
        'debug'   => true,
        'user-agent' => 'ALFI JSON Exporter/1.0',
        'dependencies' => [
            //Standard MySql -> 'SELECT version()'
            [
                'name'=>'mysql:iir_dev',
                'enabled' => false,
                'type' => 'mysql',
                'container_class' => 'pdo',
                'connection' => 'default'
            ],
            // read and write to cache using the direct transaction functions
            [
                'name'=>'redis:alfi.local',
                'enabled' => false,
                'type' => 'redis',
                'container_class' => 'predis'
            ],
            //custom healthcheck solution, in case you need something special
            [
                'name'=>'mysql:iir_dev.custom',
                'enabled' => false,
                'type' => 'mysql',
                'container_class' => 'pdo',
                'connection' => 'default',
                'tester' => [
                    'container_class' => 'CustomHcFactory',
                    'function' => 'deepMysql'
                ]
            ],
            //standard LDAP, get rootDSE
            [
                'name' => 'ldap:ldap_writer',
                'enabled' => false,
                'type' => 'ldap',
                'container_class' => 'ldap',
                'domain' => 'ldap_rw.niif.hu'
            ],
            [
                'name'=>'s3:app-iir:app-iir',
                'enabled' => true,
                'type' => 's3',
                'container_class' => 'S3',
                'connection' => 'app-iir'
            ]
        ]
    ],
?>

enabled: végezze e el a függőségek ellenőrzését vagy sem (true / false)
debug: ha true, a hibaüzeneteket visszaküldi a Response-ban, ha false akkor kiírja az error logba és válaszként egy sima "Application is unhealthy" üzenetet küld
user-agent: alapszintű védelem a HC ágnak, adott User-Agent-et vár, amit a configban megadsz, ha nincs akkor 403 hiba
dependencies: külső szolgáltatások listája amit vizsgálni szeretnél
dependency / enabled: szolgáltatás vizsgálata on / off
dependency / name: Pretty név, protokoll:név.addon formában
dependency / type: melyik beépített függvényt hívja meg (mysql,redis,ldap jelenleg a támogatott)
dependency / container_class: hol találja meg a vizsgálni kívánt objektumot a DI konténerben
dependency / tester: ha nem találod a számodra megfelelő teszt függvényt, sajátot is definiálhatsz
dependency / tester / container_class: ugyanaz mint fentebb, hol van a class a DI konténerben
dependency / tester / functions: melyik függvényt szeretnéd meghívni a fenti classból
Minden tesztelésre igaz, hogy a futtató környezet a függőségre vonatkozó teljes blokkot átadja a függvénynek, kiegészítheted saját kapcsolókkal, információkkal a settingset amit a tesztben használhatsz. Lásd a mysql-nél a connection változót pl.

Egy példa outputot itt találsz:

    //Dependencies file
        $container['ApiTester'] = function ($container) {
            return new App\Classes\ApiTester($container);
    };

    //Api Tester class
    www/app/Classes/ApiTester.php

<?php
    namespace App\Classes;

    use App\Traits\CoreTrait;

    class ApiTester
    {
        use CoreTrait;

        public function radius($settings)
        {
            return 'Hibás test, settings: '.json_encode($settings);
        }

        public function otrs($settings)
        {
            return '';
        }
    }

Egy példa outputot itt találsz:

{
    status: "pass",
    code: 200,
    checks: [
    {
        name: "mysql:oauth",
        status_code: 1,
        status: "pass",
        filter_start: 1656580073000,
        filter_end: 1656580093000,
        output: "OK",
        appname: "Sysmonitor"
    },
    {
        name: "api:partners",
        status_code: 1,
        status: "pass",
        filter_start: 1656580073000,
        filter_end: 1656580093000,
        output: "OK",
        appname: "Sysmonitor"
    },
    {
        name: "api:oraculum",
        status_code: 1,
        status: "pass",
        filter_start: 1656580073000,
        filter_end: 1656580093000,
        output: "OK",
        appname: "Sysmonitor"
    },
    {
        name: "mysql:partners_dev",
        status_code: 1,
        status: "pass",
        filter_start: 1656580073000,
        filter_end: 1656580093000,
        output: "OK",
        appname: "Sysmonitor"
    },
    {
        name: "mysql:rr",
        status_code: 1,
        status: "pass",
        filter_start: 1656580073000,
        filter_end: 1656580093000,
        output: "OK",
        appname: "Sysmonitor"
    },
    {
        name: "mysql:dashboard_rest",
        status_code: 1,
        status: "pass",
        filter_start: 1656580073000,
        filter_end: 1656580093000,
        output: "OK",
        appname: "Sysmonitor"
    },
    {
        name: "mysql:iir_dev",
        status_code: 1,
        status: "pass",
        filter_start: 1656580073000,
        filter_end: 1656580093000,
        output: "OK",
        appname: "Sysmonitor"
    },
    {
        name: "mysql:oraculum_dev",
        status_code: 1,
        status: "pass",
        filter_start: 1656580073000,
        filter_end: 1656580093000,
        output: "OK",
        appname: "Sysmonitor"
    },
    {
        name: "redis:alfi.local",
        status_code: 1,
        status: "pass",
        filter_start: 1656580073000,
        filter_end: 1656580093000,
        output: "OK",
        appname: "Sysmonitor"
    },
    {
        name: "ldap:ldap_writer",
        status_code: 1,
        status: "pass",
        filter_start: 1656580073000,
        filter_end: 1656580093000,
        output: "OK",
        appname: "Sysmonitor"
    }
    ],
    version: '1.0.0',
    time: "2022-06-30 11:07:53"
}