Skip to content

Latest commit

 

History

History
143 lines (118 loc) · 5.15 KB

uptimerobot-configuration.md

File metadata and controls

143 lines (118 loc) · 5.15 KB
Raw

UptimeRobot Configuration

Fetching alert contacts from UpTime Robot

In order to use Ingress Monitor controller, you need to have alert contacts added to your account. Once you add them via Dashboard, you will need their ID's. Fetching ID's is not something you can do via UpTime Robot's Dashboard. You will have to use their REST API to fetch alert contacts. To do that, run the following curl command on your terminal with your api key:

curl -d "api_key=your_api_key" -X POST https://api.uptimerobot.com/v2/getAlertContacts

You will get a response similar to what is shown below

[
  {
    "stat": "ok",
    "offset": 0,
    "limit": 50,
    "total": 1,
    "alert_contacts": [
      {
        "id": "123456",
        "friendly_name": "hello",
        "type": 2,
        "status": 2,
        "value": "[email protected]"
      }
    ]
  }
]

Copy values of id field of your alert contacts which you want to use for Ingress Monitor Controller and append _0_0 to them and separate them by -. You will now have a string similar to 12345_0_0-23564_0_0. This is basically the value you will need to specify in Ingress Monitor Controller's ConfigMap as alertContacts.

Configuration

Additional uptime robot configurations can be added through these fields:

Fields Description
AlertContacts The uptimerobot alertContacts to be associated with this monitor. Overrides the value of alertContacts from the Controller's ConfigMap. See Fetching alert contacts from UpTime Robot
Interval The uptimerobot check interval in seconds
StatusPages The uptimerobot public status page ID to add this monitor to. Multiple values can be given as a dash delimited string, e.g. 12345-32135-490923
MaintenanceWindows Add a maintenance windows to this check (Pro Plan only)
MonitorType The uptimerobot monitor type (http or keyword)
KeywordExists Alert if value exist (yes) or doesn't exist (no) (Only if monitor-type is keyword)
KeywordValue keyword to check on URL (e.g.'search' or '404') (Only if monitor-type is keyword)
customHTTPStatuses Defines which http status codes are treated as up or down For ex: 200:0_401:1_503:1 (to accept 200 as down and 401 and 503 as up) (Pro Plan only)

Fetching public status page ids from UpTime Robot

In order to use public status pages with the Ingress Monitor Controller you will need to have create one via the user interface.

You can then use their REST API to fetch the public status page id. To do that, run the following curl command on your terminal with your api key:

curl -d "api_key=your_api_key" -X POST https://api.uptimerobot.com/v2/getPsps

You will get a response similar to what is shown below

{
  "stat": "ok",
  "pagination":
  {
    "offset": 0,
    "limit": 50,
    "total": 1
  },
  "psps":
  [
    {
      "id": 12345,
      "friendly_name": "my-public-status-page",
      "monitors": 0,
      "sort": 1,
      "status": 1,
      "standard_url": "https://stats.uptimerobot.com/12345678",
      "custom_url": ""
    }
  ]
}

Copy values of id field of your public status page which you want to use for Ingress Monitor Controller into the relevant EndpointMonitor CR.

Fetching maintenance windows from UpTime Robot

To use maintenance windows, you must have a Pro account and have them configured in your account. Once you add them via Dashboard, you will need their ID's. Fetching ID's is not something you can do via UpTime Robot's Dashboard. You will have to use their REST API to fetch maintenance windows. To do that, run the following curl command on your terminal with your api key:

curl -d "api_key=your_api_key" -X POST https://api.uptimerobot.com/v2/getMWindows

You will get a response similar to what is shown below

{
    "stat":"ok",
    "pagination":
    {
        "limit":50,
        "offset":0,
        "total":2
    },
    "mwindows":
    [
        {
            "id":12345,
            "type":3,
            "friendly_name":"Week night maintenance slots",
            "start_time":"22:00",
            "duration":60,
            "value":"1,2,3,4,5",
            "status":1
        }
    ]
}

Copy values of id field of the maintenance windows which you want to use for Ingress Monitor Controller and separate them by -. You will now have a string similar to 12345-23564. This is basically the value you will need to specify in the maintenance-windows EndpointMonitor CR.

Example:

apiVersion: endpointmonitor.stakater.com/v1alpha1
kind: EndpointMonitor
metadata:
  name: stakater
spec:
  forceHttps: true
  url: https://stakater.com/
  uptimeRobotConfig:
    alertContacts: 60
    interval: 120
    maintenanceWindows: "maintenance-window"
    monitorType: keyword
    keywordExists: true
    keywordValue: 404
    statusPages: "status-page"