Supervision Event(3.2)

Owned by Jenni Wallin
Jun 12, 2023
5 min read

When using the Supervision Service for real-time workflows, you can configure Supervision events to be generated when certain combinations of conditions are met. These conditions are based on the current values for specified MIM parameters.

For example, you can configure a Supervision event to be generated when the throughput goes above a certain value, or when the heap size goes above a certain level, etc.

See the  Supervision Service for further information.

Filtering

In the Event Setup tab, the values for all the event fields are set by default to All in the Match Value(s) column, which will generate event notifications every time a Supervision event is generated. Double-click on the field to open the Match Values dialog where you can click on the Add button to add which values you want to filter on. If there are specific values available, these will appear in a drop-down list. Alternatively, you can enter a hardcoded string or a regular expression.

The following fields are available for filtering of Supervision events in the Event Setup tab:

Supervision event-specific fields

  • action - With this field, you can configure notifications to be sent only for certain actions. Actions are configured in Action Lists for the Decision Tables you have created for the Supervision Service in the Workflow Properties.

  • cause - With this field, you can specify to generate notifications only for events with certain descriptions. The descriptions are added when configuring your actions for the Supervision Service. 

  • value - This field enables you to configure notifications to be sent only for events with a certain content. The content is added when you configure you actions for the Supervision Service. 

    Note!

    Use regular expressions to filter on the action, cause and value fields. 

    Fields inherited from the Base event

The following fields are inherited from the Base event, and can also be used for filtering, described in more detail in Base Event(3.2):

  • category - If you have configured any Event Categories, you can select to only generate notifications for Supervision events with the selected categories. See Event Category(3.2) for further information about Event Categories.

  • contents - This field contains the action type configured in the Supervision Service, i e Supervision Event, and the cause, i e the name of the action, as well as the value.

  • eventName - This field can be used to specify which event types you want to generate notifications for. This may be useful if the selected event type is a parent to other event types. However, since the Supervision event is not a parent to any other event, this field will typically not be used for this event.

  • origin - If you only want to generate notifications for events that are issued from certain Execution Contexts, you can specify the IP addresses of these Execution Contexts in this field.

  • receiveTimeStamp - This field contains the date and time for when the event was inserted into the Platform database. If you want to use timeStamp for filtering, it may be a good idea to enter a regular expression, for example, "2012-06.*" for catching all Supervision events from 1st of June, 2012, to 30th of June, 2012.

  • severity - With this field you can determine to only generate notifications for events with a certain severity; Information, Warning, Error or Disaster. However, since Supervision events only have severity Information, this field may not be very useful for filtering.

  • timeStamp This field contains the date and time for when the Execution Context generated the event. If you want to use timeStamp for filtering, it may be a good idea to enter a regular expression, for example, "2012-06-15 09:.*" for catching all Supervision events from 9:00 to 9:59 on the 15th of June, 2012.

Fields inherited from the Workflow event

The following fields are inherited from the Workflow event, and can also be used for filtering, described in more detail in Workflow Event(3.2):

  • workflowGroupName - This field can be used for configuring Supervision event notifications to be generated only for specific workflow groups. Simply select the workflow groups you want to generate Supervision events for in the drop-down list, or enter a regular expression.

  • workflowKey - This filed can be used for configuring Supervision event notifications to be generated only for specific Workflow Keys. You can browse for the workflow keys you want to add, or enter a regular expression.

  • workflowName - This field can be for configuring Supervision event notifications to be generated only for specific Workflow Names. You can browse for the workflow names you want to add, or enter a regular expression.

Note!

The values of these fields may also be included in the notifications according to your configurations in the Notifier Setup tab.

Examples Supervision Event Configuration

Example - Supervision event notification saved in a Log File

This configuration will give you the following notification setup:

  • When a set of conditions that has an event action associated with one of the decision tables configured for Supervision Service are met, a notification will be generated.

  • When this notification is generated, a new line with information will be logged in the supervision.txt file located in the /home/user/supervision folder, containing the following data:

    • The timestamp for when the event was triggered.

    • The action type, i e Supervision Event.

    • The action description.

    • The action content.

Example - ECS Statistics Event notification sent as mail

This configuration will give you the following notification setup:

  • When a set of conditions that has an event action with a description containing "High" associated in one of the decision tables configured for Supervision Service are met, a notification will be generated.

  • When this notification is generated, an e-mail will be sent to the mail address my.mail@mycompany.com, containing the following data:

    • Supervision High-Level Alert

    • A message saying: At <the timestamp for when the event was generated> a High-Level Supervision event was generated with the following contents:.

    • The entire content of the notification will also be included in the message.