~cedric/guardian

Monitor the status of interdependent services.
Merge branch 'master' of git.sr.ht:~cedric/guardian
chg: improvements to the HTML report template.
chg: renamed all check words to tests.

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~cedric/guardian
read/write
git@git.sr.ht:~cedric/guardian

You can also use your local clone with git send-email.

#Guardian

Monitor the status of interdependent services.

  • based on a YAML file;
  • tests performed by custom scripts (Shell script, Python script, etc.);
  • no database and serverless;
  • generation of HTML status page;
  • email notifications.

#Examples

$ guardian --help
usage: guardian [-h] -c CONFIG_FILE [--email] [--html]

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG_FILE, --config CONFIG_FILE
                        Configuration file (YAML).
  --email               Send an email in case of failed test(s).
  --html                Generate a HTML status page.


$ cp guardian/config/services.yaml.example guardian/config/monarc-services.yaml


$ guardian -c guardian/config/monarc-services.yaml
+ Service my.monarc.lu
 - Test HTTPS front server
     ✅
 - Test HTTPS FO1 (casesmodels)
     ✅
 - Test HTTPS FO2 (casesmodels2)
     ✅
 - Test HTTPS Back Office
     ✅
+ Service MOSP
 - Test API
     ✅
+ Stats Service
 - Test /about.json endpoint
     ✅
✨ 🌟 ✨ All 6 tests are successful.

With email notification:

$ guardian -c guardian/config/google-services.yaml --email
+ Google services
 - Test GMail
     ✅
 - Test Web search
     ❌
 - Test Google Drive
     ✅
1 error occurred.
Execution time: 0:00:00.793011
Sending email notification...

#Contributing

Patches and questions? Send to my public inbox: ~cedric/public-inbox@lists.sr.ht. Thanks!

#License

This software is licensed under GNU Affero General Public License version 3.

Copyright (C) 2021 Cédric Bonhomme