Checkmate

Heartbeat ping key

Generate and rotate the key your jobs use to ping heartbeat monitors.

Heartbeat monitors are passive: instead of Checkmate probing something, your own job pings Checkmate when it finishes. Those pings are authenticated with a single team-wide ping key.

Manage it under Settings > Monitoring > Heartbeat ping key. Generating and rotating the key requires an Admin or Superadmin.

Generate a key

If no key exists yet, click Generate key. The key is shown once, copy it immediately, because it will not be displayed again.

Rotate a key

Click Rotate key to replace it.

Warning

The current key stops working immediately. Every job that pings a heartbeat monitor in this team must be updated with the new key or those monitors will start reporting missed heartbeats.

See also

On this page

Was this page helpful?