Configuring Heartbeat Mode
Heartbeat Mode polls a service every five minutes via a background task. The services you want to monitor are set up via the Pulse dashboard.
Setup
Pulse should only be used to monitor external services. It's not designed to monitor platform components.
To add a new service to the dashboard do the following.
- Open the Pulse shortcut on the iCM homepage
- Press "Create" in the left-hand actions menu
![Action Menu - Create]()
- Enter a meaningful ID for the service
- Enter a display name for the service (visible on the dashboard)
- Enter a link to any relevant documentation (will be output on the dashboard)
- Enter either:
- The URL of the service you'd like to monitor
- The full namespace of an end point which will be called by Pulse. The end point should call the external service
- Press "Save" in the left-hand Actions menu
Your service will now appear in the dashboard.
Advanced Settings
The following are optional and can be used to override the defaults.
| Name | Default | Description |
|---|---|---|
| Timeout | 5000 | A timeout in milliseconds |
| Degraded Latency | 2000 | The longest a request can take before it is considered "degraded" and not working correctly |
| Down Consecutive Fails | 3 | How many back to back failures occur before the service is deemed "down" |
| Window Size | 100 | The maximum number of events to use to calculate statistics |
| Retention | 345600000 (4 days) | How long, in milliseconds, are statistics are kept for before they are deleted |
| Success Response Codes | Any HTTP 2xx status code | Enter additional status codes as a comma separated list that you want to treat as successful, for example 403,404 |
Last modified on 12 May 2026
