Nastavení status.php stránky pro sledování funkcí FormFlow

Na adrese WEB_ROOT/status.php je připravena status stránka, která při načtení provede dílčí kontroly fungování FormFlow a zobrazí jak výsledky těchto kontrol, tak celkový stav, který bude hlídán systémem Nagios.

Kompletní informace o stavu FormFlow se zobrazí pouze speciálnímu uživateli „nagios“ pro kterého se generuje přístupové heslo – viz Nastavení přístupových údajů.

Pokud dojde k zjištění chybového stavu, stavová stránka status.php vyhodnotí tento stav tím, že zobrazí informaci o problému a následně ještě odešle upozornění na nastavený email.

image229

Nastavení přístupových údajů

Stavová stránka status.php, kterou kontroluje Nagios je basic autentizovaná. Jako uživatelské jméno se ve všech případech používá „nagios“, heslo je nastaveno pro každou instalaci FormFlow zvlášť a je v šifrované podobě uloženo v databázi FormFlow.

Nastavení hesla (i opakovaně) se provádí pomocí skriptu utils\set_nagios_pass.php. Požívá se následovně:

php set_nagios_pass.php [délka hesla]

Parametr [délka hesla] je nepovinný. Pokud není zadaný, vygeneruje se heslo o délce 32 znaků. Je možné vygenerovat heslo v rozmezí 16–128 znaků. Pokud je zadána délka kratší než 16 znaků, generuje se heslo o minimální povolené délce 16 znaků. Pokud je zadána délka větší než 128 znaků, generuje se heslo o maximální povolené délce 128 znaků. Od 15.7.2021 se pro jednodušší použití heslo generuje pouze z alfanumerických znaků.

Po vygenerování je heslo v šifrované podobě uloženo do databáze, a je zobrazeno uživateli nešifrovaně. Je vhodné si takto zobrazené heslo bezpečně uložit. Po zavření konzolového okna už není možné heslo opětovně zobrazit. V případě potřeby je možné vygenerovat stejným postupem nové heslo.

Zapnutí / vypnutí jednotlivých kontrol

Standardně se provádí všechny implementované kontroly a jejich výsledek se zobrazí po úspěšné autentizaci na stavové stránce status.php. Nastavením parametrů v htdocs\config.php je možné vykonávání jednotlivých kontrol potlačit – nastavením jednotlivých parametrů na hodnotu false.

Příklady použití:

  • Vypnutí kontroly databázového schématu:
    define('XMLGW_STP_CHECK_DB_SCHEMA', false);

  • Vypnutí kontroly běhu master služby:
    define('XMLGW_STP_CHECK_MASTER_SERVICE', false);

  • Vypnutí kontroly běhu služeb podřízených master službě:
    define('XMLGW_STP_CHECK_SERVICES', false);

  • Vypnutí kontroly certifikátů:
    define('XMLGW_STP_CHECK_CERTIFICATES', false);

  • Vypnutí kontroly FAS:
    define('XMLGW_STP_CHECK_FAS', false);

  • Vypnutí kontroly SFLF:
    define('XMLGW_STP_CHECK_SFLF', false);

  • Vypnutí kontroly datových schránek:
    define('XMLGW_STP_CHECK_DS', false);

  • Vypnutí kontroly volného místa v úložišti:
    define('XMLGW_STP_CHECK_DISC_SPACE', false);

  • Vypnutí kontroly webových služeb (konverze dokumentů a SecuSign ws)
    define('XMLGW_STP_CHECK_WS', false);

Všechny tyto parametry mají implicitní hodnotu true, pokud není v config.php nastaveno jinak, a tedy provádění jednotlivých kontrol je v implicitním stavu zapnuto.

Změna 15.7.2021 – volné místo je hlídáno na všech discích, které FormFlow využívá. Byla přidána možnost nastavit úroveň volného místa na disku pro varování a ohlášení chyby. Implicitně se nastavuje stav WARNING, pokud na některém z disků zbývá méně než 10 GB volného prostoru. Při poklesu pod 5 GB je nastaven stav ERROR. Tyto úrovně je možné nastavit pomocí konfiguračních parametrů:

  • Úroveň pro level WARNING (v GB):
    define('XMLGW_STP_DISC_SPACE_LEVEL_WARNING', 50);

  • Úroveň pro level ERROR (v GB):
    define('XMLGW_STP_DISC_SPACE_LEVEL_WARNING', 20);

Nastavení emailové adresy pro zasílání notifikací – pro ladění

Pokud je během kontroly konverze dokumentů a funkčnosti SecuSign SDK nalezena chyba, dochází k automatickému odeslání notifikace o nalezené chybě na emailové adresy administrátorů FormFlow. Pro ladění a testování je možné v config.php nastavit testovací emailovou adresu. Pokud je tato adresa nastavena, notifikace o nalezené chybě se odesílají jenom na uvedenou adresu a neobtěžují administrátory FormFlow. Po ukončení ladění a testování je vhodné tento parametr z config.php smazat – odesílání notifikací bude opět probíhat na emailové adresy všech administrátorů FormFlow.

Příklad nastavení testovací emailové adresy pro notifikace o chybách konverze a SecuSign SDK:

define('XMLGW_WS_CHECKER_DEBUG_NOTIF_MAIL_ADDRESS', 'nejaka+adresa@602.cz');