Configure the view health
StackState Self-hosted v5.1.x
Overview
Reacting to each event in an environment can cause a lot of noise. This may be both undesirable and unnecessary. For example, if one or multiple components have an impact on a service, it can be sufficient to report on changes to the problem itself and not each related state change.
StackState can reduce this noise by looking at the overall health state of a view rather than that of individual elements. The view health state is determined by the combined health of its elements. When a view changes its health state, a view state change event is triggered and that can in turn trigger an event notification or automated action.
![](https://docs.stackstate.com/~gitbook/image?url=https%3A%2F%2F2702698828-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Ft9xRpVRApnyVQrX3f8HH%252Fuploads%252Fgit-blob-8414735351db56a58a959ca78999c0a528729849%252Fv51_views_list.png%3Falt%3Dmedia&width=768&dpr=4&quality=100&sign=e7697de1&sv=1)
Configure view health state
View health state is calculated by a view state configuration function. To configure a view to report its health state:
In the StackState UI, click Views from the main menu.
Click the pencil icon next to a view name to edit the view.
Set View Health State Enabled to On.
Select a Configuration function to use to calculate the view health.
Provide any required arguments. These will vary according to the view health state configuration function selected. For example, for the default MINIMUM HEALTH STATES configuration function:
minCriticalHealthStates - Set to at least 1. This is the number of CRITICAL (red) health states required for the view to report a CRITICAL health state.
minDeviatingHealthStates - Set to at least 1. This is the number of DEVIATING (orange) health states required for the view to report a
DEVIATING
health state.
Click UPDATE to save the new configuration to the view.
The view health will update immediately.
![](https://docs.stackstate.com/~gitbook/image?url=https%3A%2F%2F2702698828-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252Ft9xRpVRApnyVQrX3f8HH%252Fuploads%252Fgit-blob-258c4f34d47cd16717517790a5c7c33bd0fe09f4%252Fv51_edit_query_view.png%3Falt%3Dmedia&width=768&dpr=4&quality=100&sign=a7f32c3e&sv=1)
Create your own custom View Health State Configuration functions.
Details of the available configuration functions are available in the StackState UI, go to Settings > Functions > View Health State Configuration Functions.
React to view state changes
When the View health state changes, a ViewHealthStateChangedEvent
is generated. This event can be used to trigger an event notification, such as an e-mail or Slack message.
View health state configuration functions
MINIMUM HEALTH STATES
minCriticalHealthStates and minDeviatingHealthStates must be set to 1 or higher.
When set to 0, the view will always report a CRITICAL
or DEVIATING
health state.
The MINIMUM HEALTH STATES view health state configuration function calculates the health state of the view as follows:
The view has a
CRITICAL
health state when more than the minCriticalHealthStates components inside the view have aCRITICAL
health state. This doesn't count propagated health states.The view has a
DEVIATING
health state When more than the minDeviatingHealthStates components inside the view have aDEVIATING
health state. This doesn't count propagated health states.In all other situations, the view has a
CLEAR
health state.
Use the MINIMUM HEALTH STATES view health state configuration as a starting point to create a custom view health state configuration function.
See also
Last updated