Error Alerting
In this microlearning, we’ll explore how to create and customize error alerts within your eMagiz environment. This functionality allows you to create a trigger that will generate an alert, as well as send you a notification, whenever error messages with certain conditions are raised. We’ll cover the trigger checks that are available for the error alerting and guide you through configuring them to suit your requirements. This will help you ensure your error alerts are as effective and relevant as possible. Should you have any questions, please contact academy@emagiz.com.
1. Prerequisites
- Basic knowledge of the eMagiz platform
- Basic knowledge of alerting in the eMagiz platform
2. Key concepts
This microlearning focuses on creating and customizing the error alerts that are existing in each of the environment of your model (i.e., Testing-Acceptance-Production).
- There are four checks that eMagiz currently provides that will raise an alert from the error messages:
- Message header
- Exception class
- Exception message
- Runtime check
- Recipients are defined on each error alert trigger.
3. Error Alerting
Error alerting refers to the configuration of triggers that will generate an alert, as well as send you a notification, whenever error messages with certain conditions are raised. This functionality is most likely relevant when an alert needs to be generated whenever a specific error message with certain characteristics (e.g., a particular header value or a particular exception message) is raised and that alert needs to be sent to a different set of recipients.
Similar to the queue alerting, you can find the overview of the error alerting by navigating to Manage->Alerting->Triggers, then under the "Errors" tab you will find all of the error alert triggers, if you have created them already, for the environment that you are working with at the moment (i.e., Testing, Acceptance, Production). To create a new error trigger, you can press the "Add" button. Otherwise, if you want to edit an existing error alert trigger, you can click the green edit button on the right side of each trigger.
eMagiz currently provides four checks that will raise an alert from the error messages, namely, by evaluating the Message header, Exception class, Exception message, and the Runtime where the error message is raised. In the following sections, we will discuss how you can create an error trigger and tune its trigger checks to match your needs.
3.1 Evaluate message header
This check evaluates whether an alert should be generated when an error message is raised based on the header contained in the message.
If you set it to "Ignore", then message headers will not be evaluated when deciding whether to raise an alert. If set to "By Condition," you can specify which header name to evaluate and define conditions such as whether it equals, does not equal, contains, or does not contain a specific value.
3.2 Evaluate exception class
This check evaluates whether an alert should be generated based on the exception class of the error message when it is raised.
3.3 Evaluate exception message
This check evaluates whether an alert should be generated based on both the first and last exception message of the error message when it is raised.
3.4 Runtime check
This check evaluates whether an alert should be generated when an error message is raised from which runtime in the environment.
4. Key takeaways
- As a user with the edit rights in Manage of a particular environment, you can modify the default values for all of your queue triggers or customize the trigger configurations of individual queues.
- eMagiz provides four queue trigger options: Consumers Check (monitoring the number of processes consuming messages), Queue Load Check (monitoring the number of queued messages), Inactivity Check (ensuring regular received message), and Periodic Activity Check (ensuring a minimum number of messages within a specified interval).
- Once you save your trigger configurations, they will take effect immediately.
5. Suggested Additional Readings
If you are interested in this topic and want more information, please read the help text provided by eMagiz and read the following microlearning.