https://github.com/ssube/uptimerobot-exporter

Prometheus Exporter for the UptimeRobot API
https://github.com/ssube/uptimerobot-exporter

prometheus prometheus-exporter prometheus-metrics uptime uptime-monitor uptime-robot uptimerobot uptimerobot-api

Last synced: 12 days ago
JSON representation

Prometheus Exporter for the UptimeRobot API

• Host: GitHub
• URL: https://github.com/ssube/uptimerobot-exporter
• Owner: ssube
• License: mit
• Created: 2021-08-07T04:41:09.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-10-09T11:19:12.000Z (about 1 year ago)
• Last Synced: 2024-11-05T11:28:17.098Z (about 2 months ago)
• Topics: prometheus, prometheus-exporter, prometheus-metrics, uptime, uptime-monitor, uptime-robot, uptimerobot, uptimerobot-api
• Language: JavaScript
• Homepage:
• Size: 11.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Uptime Robot Exporter

This is a Prometheus exporter for the Uptime Robot monitoring API.

## API Auth

The Uptime Robot API offers read-only keys, meant for reading the monitor response times.

1. Create a new `Read-Only API Key` in the dashboard, https://uptimerobot.com/dashboard#mySettings

2. Put the resulting secrets in an `.env` file or k8s secret

3. Mount or source those secrets before running `node index.js`

## Configuration

The following environment variables must be set:

- `UPTIME_KEY`

  - the read-only API key

## Metrics

The API has a GetMonitors endpoint that exposes the average and last sampled response times for each monitor.

The last response time has a corresponding timestamp, and may not be the current response time. The average is

calculate by the API.

- `uptimerobot_response_last_seconds`

  - `id`

    - number

  - `name`

    - friendly name

- `uptimerobot_response_avg_seconds`

  - `id`

    - number

  - `name`

    - friendly name

- `uptimerobot_status`

  - `id`

    - number

  - `name`

    - friendly name

Metrics are fetched once on startup, then on a scheduled interval, by default every 10 minutes.