Sign inSign up

eeacms/garie-uptimerobot

By eeacms

•Updated 3 months ago

Garie plugin for uptimerobot uptime stats

Image
0

6.5K

eeacms/garie-uptimerobot repository overview

⁠Garie uptimerobot plugin

Tool to gather Uptimerobot statistics, and supports CRON jobs.

Highlights

  • Poll for uptimerobot⁠ statistics and stores the data into InfluxDB
  • View all historic reports.
  • Setup within minutes

⁠Overview of garie-uptimerobot

Garie-uptimerobot was developed as a plugin for the Garie⁠ Architecture.

Garie⁠ is an out the box web performance toolkit, and garie-securityheaders is a plugin that generates and stores securityheaders data into InfluxDB.

Garie-uptimerobot can also be run outside the Garie environment and run as standalone.

If your interested in an out the box solution that supports multiple performance tools like securityheaders, google-speed-insight and lighthouse then checkout Garie⁠.

If you want to run garie-uptimerobot standalone you can find out how below.

⁠Getting Started

⁠Prerequisites
  • Docker installed
⁠Running garie-uptimerobot

You can get setup with the basics in a few minutes.

First clone the repo.

git clone https://github.com/eea/garie-uptimerobot.git

Next setup you're config. Edit the config.json and add websites to the list.

{
  "plugins":{
        "uptimerobot":{
            "cron": "*/2 * * * *"
        }
    },
  "urls": [
    {
      "url": "https://www.eea.europa.eu/"
    },
    {
      "url": "https://www.eionet.europa.eu/"
    }
  ]
}

Once you finished edited your config, lets setup our environment.

docker-compose up

This will build your copy of garie-uptimerobot and run the application.

On start garie-uptimerobot will start to gather statistics for the websites added to the config.json.

⁠config.json

PropertyTypeDescription
plugins.uptimerobot.cronstring (optional)Cron timer. Supports syntax can be found [here].(https://www.npmjs.com/package/cron⁠)
plugins.uptimerobot.retryobject (optional)Configuration how to retry the failed tasks
plugins.uptimerobot.retry.afternumber (optional, default 30)Minutes before we retry to execute the tasks
plugins.uptimerobot.retry.timesnumber (optional, default 3)How many time to retry to execute the failed tasks
plugins.uptimerobot.retry.timeRangenumber (optional, default 360)Period in minutes to be checked in influx, to know if a task failed
plugins.uptimerobot.max_age_of_report_filesnumber (optional, default 365)Maximum age (in days) for all the files. Any older file will be deleted.
plugins.uptimerobot.delete_files_by_typeobject (optional, no default)Configuration for deletion of custom files. (e.g. mp4 files)
plugins.uptimerobot.delete_files_by_type.typestring (required for 'delete_files_by_type')The type / extension of the files we want to delete. (e.g. "mp4").
plugins.uptimerobot.delete_files_by_type.agenumber (required for 'delete_files_by_type')Maximum age (in days) of the custom files. Any older file will be deleted.
urlsobject (required)Config for lighthouse. More detail below

urls object

PropertyTypeDescription
urlstring (required)Url to get uptimerobot metrics for.

⁠Variables

Can have multiple accounts/keys. Will extract the uptime for the last number of days ( configured in environment ).

  • UPTIME_ROBOT_KEYS - List of keys, separated by space
  • UPTIME_API_URL - Uptimerobot api url
  • UPTIME_INTERVAL_DAYS - Interval to check the monitors on

⁠Usage

Use example.env as a template for .env file with the correct values.

cp example.env .env

For more information please go to the garie-plugin⁠ repo.

Tag summary

Content type

Image

Digest

sha256:789862fc9…

Size

345.7 MB

Last updated

3 months ago

docker pull eeacms/garie-uptimerobot