NASA-PDS / PlanetPatrol

Monitoring and notification system using GitHub Actions and Upptime
https://nasa-pds.github.io/PlanetPatrol/
MIT License
1 stars 0 forks source link
monitoring uptime

🪐 Planet Patrol

"Planet Patrol" is a demonstration monitoring and notification system for the Planetary Data System. It keeps tabs of essential websites, APIs, and other online endpoints, files tickets when things aren't working, makes notifications (when configured to do so), and keeps things up and running, and neat and tidy.

🏃‍♀️ Getting Started

Check the documentation for Upptime first. Then do a git pull because the GitHub Actions that powers this make numerous commits to the repository all the time. Then edit the .upptimerc.yml file and commit and push.

You can then view the results at the Planet Patrol website (powered by GitHub Pages).

As systems go down, issues are automatically filed and assigned (powered by GitHub Issues).

🚨 Notifications

Email notifications are currently being tested. They're being sent using JPL SMTP using a "service" account managed by @nutjob4life. They're allegedly going to four different addresses (the NOTIFICATION_EMAIL_TO secret). The documentation doesn't make it clear what the delimiter is between multiple email addresses, so we're trying commas (,) for now.

Other notification options in the future include Teams messages, Slack pings, Discord integration, SMS messages, and so forth.

🖥 The Software

This effort is based on Upptime.

👥 Contributing

You can always look at open issues and/or make pull requests.

📃 License

The project is licensed under the Apache version 2 license. It's based on Upptime, which is license under the MIT license.