Docs
Heartbeat monitors

Settings

Table of contents
  1. Name
  2. Time settings
    1. Interval
    2. Tolerance
  3. Rules
    1. bool rules
    2. int rules
    3. str rules

Let's go over configuration parameters for heartbeat monitors.

Name

Name is the displayed name/title of the monitor. It is used both on the application and the status page. When multiple monitors are listed, they are sorted alphabetically by the name.

Time settings

Interval

Interval is the frequency of the expected HTTP response. It should be 24 hours for a daily task, 7 days for a weekly one, etc.

Tolerance

Tolerance is a utility configuration parameter, useful especially for tasks with a varying process time. WebGazer waits as much as this tolerance, before marking the monitor as down when a request isn't delivered on time.

For example, for a heartbeat monitor with 24 hours as interval, and 10 minutes as tolerance, if a request is sent on August 20 - 07:00 the next requested is expected before August 21 - 07:10. If the request doesn't arrive until August 21 - 07:10, monitor will be marked as down.

Rules

Rules are the success criteria for incoming requests. When a heartbeat monitor HTTP request hits WebGazer, it is evaluated according to the configured rules. Query part of the URL is parsed for the parameters.

A rule consists of four parts:

  • Parameter name
  • Parameter type (bool, int or str)
  • Condition
  • Expected value
When multiple rules are configured for a heartbeat monitor, incoming requests are evaluated simply by the union of these rules. Rule engine-like complex conditioning is not available.

bool rules

Configuration examples:

  • success (bool) == true
  • fail (bool) != false

Example URL: https://heartbeat.webgazer.io/1-8d9883d14649?success=true

int rules

Configuration examples:

  • seconds (int) <= 10
  • percentage (int) == 100

Example URL: https://heartbeat.webgazer.io/1-8d9883d14649?seconds=3

str rules

Configuration examples:

  • name (str) == alice
  • server (str) != main

Example URL: https://heartbeat.webgazer.io/1-8d9883d14649?name=alice