Heartbeat Format

Heartbeats received by Alerta conform to the following format.

Attributes

The following heartbeat attributes are populated at source:

Attribute	Description
`id`	globally unique random UUID
`origin`	name of monitoring component that generated the heartbeat
`tags`	set of tags in any format eg. `aTag`, `aDouble:Tag`, `a:Triple=Tag`
`attributes`	dictionary of key-value pairs
`type`	heartbeat type. only `Heartbeat` is currently supported
`createTime`	UTC date and time the heartbeat was generated in ISO 8601 format
`timeout`	number of seconds before heartbeat is considered stale

Note

Only origin is mandatory.

Attributes added when processing heartbeats

Attribute	Description
`receiveTime`	UTC date and time the heartbeat was received by the Alerta server daemon
`customer`	assigned based on the owner of the API key used when submitting the heartbeat, if “Customer Views” are enabled
`latency`	round-trip latency in milliseconds (computed from `createTime` and `receiveTime`)
`maxLatency`	maximum acceptable latency threshold from `HEARTBEAT_MAX_LATENCY` config (default 2000ms)
`since`	seconds since last heartbeat was received
`status`	computed status: `ok` if within timeout and latency threshold, `slow` if latency exceeds `maxLatency`, `expired` if timeout exceeded
`href`	URL reference to the heartbeat resource

Example

{
  "attributes": {
    "environment": "Production",
    "group": "Network",
    "service": [
      "Core",
      "HA"
    ],
    "severity": "major"
  },
  "createTime": "2020-06-07T20:31:58.244Z",
  "customer": null,
  "href": "http://api.alerta.io/heartbeat/ea2f41e3-16c4-412f-aaf2-874e3c4c771b",
  "id": "ea2f41e3-16c4-412f-aaf2-874e3c4c771b",
  "latency": 0,
  "maxLatency": 2000,
  "origin": "cluster05",
  "receiveTime": "2020-06-07T20:31:58.244Z",
  "since": 91,
  "status": "ok",
  "tags": [
    "db05",
    "dc2"
  ],
  "timeout": 120,
  "type": "Heartbeat"
}