Utilities / Telegraf Plugins: 6d08ba23

verified

Add README

Add README

Commit 6d08ba23.

Authored 2021-12-04T15:34:52.000+00:00 by B Tasker in project Utilities / Telegraf Plugins

+42 lines -0 lines

Commit Signature

Changes

diff --git a/uptime-robot/README.md b/uptime-robot/README.md
--- a/uptime-robot/README.md
+++ b/uptime-robot/README.md
# @@ -0,0 +1,42 @@
# +# Uptime Robot Telegraf Exec Plugin
# +
# +`exec` plugin to poll [Uptime Robot](https://uptimerobot.com)'s API and retrieve stats for all monitored endpoints.
# +
# +This'll collect
# +
# +- Current status
# +- Average response times
# +
# +
# +### Setup
# +
# +You'll need to get an API key (read-only is strongly recommended)
# +
# +- Go to https://uptimerobot.com/dashboard#mySettings and login
# +- On the right should be a block for Read-Only API key
# +- Create one if there isn't already one
# +- Set it in the head of the exec script
# +
# +
# +#### Telegraf Config
# +
# +Configuration in Telegraf is simple - assuming the script `uptime-robot.py` has been saved in `/usr/local/src/telegraf-plugins`:
# +```
# +[[inputs.exec]]
# + commands = [
# + "/usr/local/src/telegraf_plugins/uptime-robot.py",
# + ]
# + timeout = "60s"
# + interval = "5m"
# + name_suffix = ""
# + data_format = "influx"
# +```
# +
# +Note: unless you've got an Uptime-Robot Pro account, there's no point in an interval of < 5m as that's how often the checks run on their end.
# +
# +
# +---
# +
# +### Copyright
# +
# +Copyright (c) 2021 [Ben Tasker](https://www.bentasker.co.uk)
#