Skip to content

Latest commit

 

History

History
47 lines (38 loc) · 1.91 KB

README.md

File metadata and controls

47 lines (38 loc) · 1.91 KB
Raw

JarvisMonitor

Monitor that runs in the background to report the health status of Jarvis and its processes

Sample Crontab Entry

* * * * * cd ~/JarvisMonitor && python run.py

GitHub workflow trigger is set to trigger on push against docs branch which will build GitHub pages.

Sample Report

Process Name Status
Jarvis 🟢
Jarvis API 🟢
Background Tasks 🟢
Speech Synthesis API 🔴

References

Environment Variables

Environment variables are case insensitive.

Mandatory

  • source_map - Path to the processes.yaml file generated by Jarvis
  • git_user - GitHub username to authenticate GitPython
  • git_token - GitHub PAT to push changes using GH API and authenticate GitPython

Optional

  • debug - Any value to enable debug mode. Disabled by default.
  • git_owner - GitHub owner for the account. Defaults to thevickypedia
  • gmail_user - Gmail username to authenticate the account.
  • gmail_pass - gmail password to authenticate the account.
  • recipient - Email address to send an email notification.
  • skip_schedule - Skip the monitoring schedule at a particular time. Example: 12:00 AM
  • check_existing - Check existing index.html file for changes, before executing push. Defaults to True
  • override_check - List of minutes to set the check_existing flag as False. Defaults to [0] (every hour)
  • log_retention - Number of days worth of logs to retain. Defaults to 3