okibot/cachet-uptime-robot repository overview

⁠Cachet Uptime Robot

Cachet is an open source status page system, this repository is a Python script that does two things, first, it reads the status of a page in UptimeRobot and updates a cachet component based on that status and second, it updates a metric with the historic uptime ratio from Uptime Robot.

Component status: Uptime Robot (left), Cachet (right)

• Not checked yet: Operational
• Up: Operational
• Seems down: Partial outage
• Down: Major outage

⁠Getting started

To get started, you have to specify your Cachet and UptimeRobot settings and in config.ini.

[uptimeRobot]
UptimeRobotMainApiKey = your-api-key

[https://url.in.uptime.robot.com]
CachetApiKey = cachet-api-key
CachetUrl = https://status.mycompany.com
MetricId = 1
ComponentId = 1

• CachetApiKey: Cachet API key.
• https://url.in.uptime.robot.com: This exact "monitor" url set in UptimeRobot (eg. http://mywebsite.com⁠)
• CachetUrl: URL of the API of the status page you want to show the site availability in.
• MetricId: Id of the Cachet metric with site availability.
• ComponentId: (Optional) Id of the component you want to update on each check.

⁠Usage

Register a cron that runs update_status.py every 5 minutes.

# Open cron file to edit.
crontab -e

Edit the crontab file and add this line:

*/5 * * * * python3 ~/path/update_status.py ~/path/config.ini

Note that the path of the update_status.py & config.ini files may vary depending on the location you cloned the repository

⁠Running manually

You can also update your Cachet data manually by running this:

python3 update_status.py config.ini

>>> Updating monitor MySite. URL: http://mysite.co. ID: 12345678
>>> Metric created: {'data': {'calculated_value': 99.99, 'counter': 1, 'metric_id': 4, 'value': 99.99, 'created_at': '2016-08-12 08:23:10', 'updated_at': '2016-08-12 08:23:10', 'id': 99}}