One of the main aspects of monitoring connected products is their health status and the presence of failures.
Failure events can be used to identify the presence of critical problems, for instance the product is blocked, down, or unavailable.
A Failure is described by:
Name: the name of the failure (e.g. TAPE_ERROR_1).
Title: the user-friendly name of the event (e.g. Tape blocked).
Description: the event description (e.g. The tape is blocked due to the presence of.....).
Group: the name of the group to which this event belongs.
The group can be used to filters and groups events into the DPS pages.Topics: the set of topics to which this event relates (CONNECTION, CONSUMPTION, DOWNTIME, HEALTH, PRODUCTIVITY, QUALITY, UPTIME).
Topics are predefined and can be used to filters and groups events into the DPS pages.Active/Clear Conditions: the metric/property-based conditions used to activate/deactivate the event instance.
In case of property-based condition, you can use only properties of type DATE.Troubleshooting: a set of remedies the user can follow to fix the problem by himself.
Options: a set of variables that can be used to let the user customize the thresholds for event triggering.
Alert: how to notify the event to the users.
Note that a FAILURE event, by default is associated to CRITICAL severity and FAILURE category.
Creating a Failure
To add a new Failure event, you should:
Enter the Events / Failures page.
Select the Location or Thing Definitions tab, depending on where you want to create the event.
In case of Thing Definition, select the Thing Definition to edit.
Press the Add Event button.
Provide the required information.
Press the Save button and edit the additional information, if needed.
Editing a Failure Event
A Failure event is described by the following sections:
General
The main section describing the event through these properties:
Name: specifies the name of the event, it is a free value (e.g. TEMP WARNING).
Title: the event shown title within the event list.
Description: the text describing the occurred problem.
Severity: fixed to CRITICAL
Category: fixed to FAILURE
Within the event Title, and Description it is possible to use placeholders to include information about the thing, the event, and measures.
Dashboard
Event Template: the template used to display the event details in a dedicated dashboard.
Active and Clear Conditions
This section allows defining when the event must be activated or cleared.
For more details about how to define conditions refer to the Event Trigger Conditions article.
In case the event is not User Reported:
If the clear condition is not specified, the negated active condition is used.
To activate a new event, the activation timestamp of the clear condition must be prior to the activation timestamp of the active condition, and there are no events of the same type still active.
An event is periodically evaluated and is triggered only when the active condition changes from false to true and remains true for at least one evaluation interval (e.g. 60 seconds). This means that in case of metric-based conditions, metric values with a duration of less than one evaluation interval (e.g. 60 seconds) may not be detected in order to correctly trigger the event.
Technical Description and Remedies
Here you can describe more technically the event that has occurred and which are the causes and impacts. Optionally, you can provide a set of remedies, the user can follow to fix the problem by itself.
Remedies are presented to the user through the Thing Troubleshooting widget.
Options
This section allows defining options to be used within the event definition and whose value can be redefined by the end-user within the page by suing the thing-options widget.
For more details, see the Options article.
Alert
This section allows defining whether the Event must be notified to users through an Alert.
By clicking the Add Alert Button, you can create a new Alert for the event.
Event Refactoring
In case you have wrongly defined a failure that should instead be an anomaly, you can convert the event by clicking the Convert to Anomaly button present in the page bottom.