https://github.com/thevickypedia/jarvismonitor
Health status of https://jarvis.vigneshrao.com
https://github.com/thevickypedia/jarvismonitor
Last synced: 2 months ago
JSON representation
Health status of https://jarvis.vigneshrao.com
- Host: GitHub
- URL: https://github.com/thevickypedia/jarvismonitor
- Owner: thevickypedia
- Created: 2023-12-13T03:05:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-05T20:15:02.000Z (3 months ago)
- Last Synced: 2025-03-05T20:18:57.954Z (3 months ago)
- Language: Python
- Homepage: https://jarvis-health.vigneshrao.com
- Size: 317 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JarvisMonitor
Monitor that runs in the background to report the health status of Jarvis and its processes
### Sample Crontab Entry
```bash
* * * * * 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
- Source Repo: [Jarvis][1]
- Status Page: [Health][2]
- Internal Preview: [Preview][3]
### Environment Variables
> Environment variables are case insensitive.
**Mandatory**
- **source_map** - Path to the processes.yaml file generated by [Jarvis][4]
- **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`
[1]: https://github.com/thevickypedia/Jarvis
[2]: https://jarvis-health.vigneshrao.com
[3]: https://htmlpreview.github.io/?https://github.com/thevickypedia/JarvisMonitor/blob/docs/docs/index.html
[4]: https://github.com/thevickypedia/Jarvis