Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Export uptimerobot.com monitor results as prometheus.io metrics

Project description

https://travis-ci.org/wosc/prometheus-uptimerobot.png

This packages exports Uptime Robot monitor results as Prometheus metrics.

Usage

Configure API key

You’ll need to provide the API key of your uptimerobot.com account using a configuration file:

[default]
api_key = 123456789

See the Uptime Robot API documentation for details.

Set up HTTP service

Then you need to set up an HTTP server, either with a dedicated process:

$ uptimerobot_exporter --host localhost --port 9429 --config /path/to/config

or as a CGI script, if you have infrastructure for that set up anyway. Here’s an example apache configuration snippet to do this:

ScriptAlias /metrics/uptimerobot /path/to/uptimerobot_exporter_cgi
<Location /metrics/uptimerobot>
  SetEnv PROMETHEUS_UPTIMEROBOT_CONFIG /path/to/config
  # SetEnv PROMETHEUS_UPTIMEROBOT_LOGFILE /path/to/log  # optional, for debugging
</Location>

Configure Prometheus

scrape_configs:
  - job_name: 'uptimerobot'
    scrape_interval: 300s
    static_configs:
      - targets: ['localhost:9429']

The following metrics are exported, each with labels {monitor_name="example.com",monitor_type="http",monitor_url="https://example.com"}:

  • uptimerobot_up gauge (1=up, 0=down)
  • uptimerobot_status gauge
  • uptimerobot_responsetime gauge
  • uptimerobot_ssl_expire gauge (unix timestamp), if applicable

See the Uptime Robot API documentation section “Parameters” for details on the possible status values. The monitor_type is translated from its numeric code to one of http, http keyword, ping, or port.

Additionally, a uptimerobot_scrape_duration_seconds gauge is exported.

CHANGES

1.1.0 (2018-09-17)

  • Add ssl expiration metrics

1.0.1 (2018-04-02)

  • Support pagination of API results.

1.0.0 (2018-04-01)

  • First release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ws.prometheus-uptimerobot, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size ws.prometheus_uptimerobot-1.1.0.tar.gz (6.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page