Links

Manage event handlers

StackState Self-hosted v5.1.x

Overview

Event handlers attached to a StackState view listen to events that are generated in relation to components in the view. Event notifications can then be sent or actions can be triggered in response to health state change events or problem events.

Configured event handlers

All event handlers configured for the view are listed in the StackState UI right panel View summary tab under Event handlers. You can add, edit and remove event handlers from here. Expand an event handler to see its configured settings.
The badge on the right next to the Event handlers section heading shows the number of event handlers configured for the view.
Event handlers

Add event handler

You can add an event handler to a view from the StackState UI right panel View summary tab.
Event handlers can only be added to a saved view. It isn't possible to add event handlers to subviews or while in explore mode.
Add event handler
  1. 1.
    Open a view.
  2. 2.
    Select the View summary tab in the right panel.
  3. 3.
    Expand the Event handlers section. All currently configured event handlers are listed.
  4. 4.
    To add a new event handler, click ADD NEW EVENT HANDLER. The Add Event Handler popup opens.
  5. 5.
    Give the event handler a Name.
  6. 6.
    You can optionally add a Description. This will be displayed in the tooltip whenever a user hovers the mouse pointer over the event handler name in the right panel Event handlers list.
  7. 7.
    Select the trigger event and the event handler to run:
    • On event - the event types that should trigger the event notification or automated action. Note that only events related to components are captured in event handlers, relation-related events will be ignored.
    • Run event handler - the event handler function that will run whenever the selected event type is generated.
  8. 8.
    Enter the required details, these will vary according to the event handler function you have selected.
  9. 9.
    Click SAVE.

Event handler functions

Event handlers listen to events generated within a view. When the configured event type is generated, an event handler function is run to send an event notification or trigger an action in a system outside of StackState. For example, an event handler function could send a message to a Slack channel or make a POST to a webhook URL. A number of default event handler functions are included out of the box with StackState, these are described below.

Slack

The Slack event handler function sends a Slack message with detailed information about the trigger event, including the possible root cause, to the configured Slack webhook URL. See how to create a Slack Webhook (slack.com).
Can be triggered by Health state change events and Problem events.
Requires the Slack StackPack to be installed on your StackState instance.

HTTP webhook POST

The HTTP webhook POST event handler function sends a POST request to the specified URL.
Can be triggered by Health state change events only.

SMS

The SMS event handler function sends an SMS with details of a health state change event using MessageBird.
Can be triggered by Health state change events only.

Email

The email event handler function will send details of a health state change event using a configured SMTP server.
Can be triggered by Health state change events only.

Custom functions

See also