Add a health check

Report the health state for an element.


Health checks use check functions to report the status of elements (components and relations) in StackState based on the data from telemetry streams. Any element in a StackState topology view with a telemetry stream attached can be monitored by a health check. When the status of an element changes, a state change event is generated. These events can be used to trigger event notifications and actions.

Add a health check to an element

Most elements in the StackState topology will have a relevant health check added when the are created. If required, you can assign additional custom health checks to an element in the StackState Topology Perspective.

Health checks require telemetry streams.

Add a health check to an element
  1. Select the element that you want to assign a health check to.

  2. Click + ADD next to Health on the right of the screen.

    • An Add check dialog box appears.

  3. Provide the following details:

    • Name - The health check name. Will be displayed in the StackState UI Health pane.

    • Description - Optional, can be used to explain the check in greater detail.

    • Remediation hint - Optional, will be automatically displayed on the element when this check goes to a non clear state, for example critical or deviating.

    • Check function - The check function to use to monitor the element's telemetry stream(s). See Check functions below.

  4. Provide the required check function arguments, these will vary according to the check function selected, but will include:

    • At least one telemetry stream. Some checks will require multiple streams.

    • For metrics check functions, a windowing method and window size.

  5. Click CREATE to create the health check.

    • The check is now active and visible under the Health section on the right side of the screen.

    • The check will remain gray until enough telemetry data has been received to determine a health state.

Check functions

Each health check uses a check function to monitor the telemetry stream attached to the element.

Check functions are scripts that take streaming telemetry as an input, check the data based on its logic and on the supplied arguments and output a health state. The telemetry changes a check function responds to determine the way in which the health check reports element health state, for example by monitoring a metric stream for thresholds and spikes, or checking the generated events. A number of check functions are included out of the box with StackState, or you could create your own.

Details of the available check functions check the StackState UI Settings > Check functions.

Windowing method

For metrics check functions, a windowing method and window size must be provided. This determines how often the check function will run based on the incoming metrics. There are two possible windowing methods, batching and sliding.


The batching windowing method groups metric data into strictly separate windows of the configured window time, with consistent start and end times. For example, with window size set to 60 seconds, a batching check will run every minute with metrics from the previous minute.


The sliding windowing method groups metric data into overlapping windows. For example, with window size set to 60 seconds, a sliding check will run whenever the data flows in after 60 seconds of metrics have been collected. Note that runs of the check will adhere to the Minimum live stream polling interval configured for the data source.

Check function: Autonomous metric stream anomaly detection

The Autonomous metric stream anomaly detection health check reacts to anomaly events and sets the component health state to the DEVIATING (orange). Read more about how to use anomaly health checks.

See also