Skip to Content

Wiki source code of Error Alerting

Last modified by dfirdausy on 2024/11/20 10:07
Hide last authors
Erik Bakker 17.1 1 {{container}}{{container layoutStyle="columns"}}(((
dfirdausy 63.17 2 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>>mailto:academy@emagiz.com]].
marijn 1.1 3
dfirdausy 63.5 4 {{info}}Note that this documentation explains the latest design of eMagiz Error Alerting that is introduced in [[Release 234>>Main.Release Information.Release Blogs.234 - Alert Adventures||target="blank"]] and the Error Alerting explained in this page is only applicable for eMagiz models that are running the [[current generation architecture>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]{{/info}}
dfirdausy 46.1 5
marijn 1.1 6 == 1. Prerequisites ==
7
8 * Basic knowledge of the eMagiz platform
dfirdausy 41.1 9 * Basic knowledge of alerting in the eMagiz platform
marijn 1.1 10
11 == 2. Key concepts ==
12
dfirdausy 63.6 13 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).
marijn 1.1 14
dfirdausy 63.6 15 * There are four checks that eMagiz currently provides that will raise an alert from the error messages:
16 ** Message header
17 ** Exception class
18 ** Exception message
19 ** Runtime check
dfirdausy 63.12 20 * Recipients are defined on each error alert trigger.
marijn 1.1 21
dfirdausy 63.6 22 == 3. Error Alerting ==
dfirdausy 63.17 23 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.
marijn 1.1 24
dfirdausy 63.8 25 [[image:Main.Images.Microlearning.WebHome@novice-alerting-error-alerts-overview.png]]
dfirdausy 63.7 26
dfirdausy 63.13 27 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.
dfirdausy 63.7 28
dfirdausy 63.13 29 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.
30
dfirdausy 63.46 31 {{info}}When setting up the error alert triggers, these considerations apply:
dfirdausy 63.42 32 * An alert will be generated for an error message only if all checks and conditions specified in a trigger apply.
dfirdausy 63.44 33 * If all checks in a trigger is set to "Ignore", then you will get an alert for every error message that is raised.
dfirdausy 63.42 34 {{/info}}
dfirdausy 63.25 35
dfirdausy 63.14 36 === 3.1 Evaluate message header ===
marijn 1.1 37
dfirdausy 63.19 38 This check evaluates whether an alert should be generated when an error message is raised based on the header contained in the message.
dfirdausy 63.15 39
dfirdausy 63.17 40 [[image:Main.Images.Microlearning.WebHome@novice-alerting-error-alerts-evaluate-message-header.png]]
41
dfirdausy 63.26 42 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," then you can specify what header name to evaluate and define conditions such as whether it equals, does not equal, contains, or does not contain a specific value to result in an alert.
dfirdausy 63.19 43
dfirdausy 63.14 44 === 3.2 Evaluate exception class ===
dfirdausy 43.3 45
dfirdausy 63.22 46 This check evaluates whether an alert should be generated based on the exception class of the error message when it is raised.
47
dfirdausy 63.20 48 [[image:Main.Images.Microlearning.WebHome@novice-alerting-error-alerts-evaluate-exception-class.png]]
49
dfirdausy 63.26 50 If you set it to "Ignore", then the exception class will not be evaluated when determining whether an alert should be raised. If set to "By Condition", then you can specify what exception class to evaluate and define conditions such as whether it equals, does not equal, contains, or does not contain a specific value to result in an alert.
dfirdausy 63.23 51
dfirdausy 63.14 52 === 3.3 Evaluate exception message ===
dfirdausy 57.10 53
dfirdausy 63.22 54 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.
55
dfirdausy 63.21 56 [[image:Main.Images.Microlearning.WebHome@novice-alerting-error-alerts-evaluate-exception-message.png]]
dfirdausy 63.20 57
dfirdausy 63.26 58 If you set it to "Ignore", then the exception message will not be evaluated when determining whether an alert should be raised. If set to "By Condition," then you can specify a string to check in both the first and last exception messages, and define conditions like equals, not equals, contains, or does not contain to result in an alert.
dfirdausy 63.20 59
dfirdausy 63.14 60 === 3.4 Runtime check ===
dfirdausy 57.10 61
dfirdausy 63.22 62 This check evaluates whether an alert should be generated when an error message is raised from which runtime in the environment.
63
dfirdausy 63.21 64 [[image:Main.Images.Microlearning.WebHome@novice-alerting-error-alerts-runtime-check.png]]
dfirdausy 57.23 65
dfirdausy 63.26 66 If you set it to "Ignore", then which runtime where the error occured will not be evaluated when determining whether an alert should be raised. If set to "By Condition", then you can specify which runtime where the error message occured to result in an alert.
dfirdausy 57.10 67
dfirdausy 63.47 68 === 3.5 Instruction ===
dfirdausy 63.33 69
70 Additionally, you can also specify a custom instructions that will be included in both the email notifications sent to recipients as well as in the alert message displayed in the Manage->Alerting->Alerts.
71
72 [[image:Main.Images.Microlearning.WebHome@novice-alerting-error-alerts-instructions.png]]
73
dfirdausy 63.31 74 Lastly, upon saving, these settings will apply immediately, putting the new error alert trigger into effect. Next to that, on this page, you can also find the "Notifications" tab that allows you to configure which recipients that you want to receive the notifications from the error alerting. If you want to learn more about this notifications and how to configure it, please refer to this [[microlearning>>Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3||target="blank"]].
dfirdausy 63.30 75
Erik Bakker 30.1 76 == 4. Key takeaways ==
77
dfirdausy 63.38 78 * eMagiz allows users to create and customize error alerts by defining triggers that will raise alerts and send notifications when error messages with specific conditions occur.
dfirdausy 63.32 79 * eMagiz provides four checks for error alerts: message header, exception class, exception message, and runtime. These checks can be configured to evaluate conditions such as "equals," "not equals," "contains," or "does not contain" to determine if an alert should be triggered.
80 * Alerts are generated only if all specified checks in a trigger are met. Users can also configure recipients for error alert notifications, ensuring messages reach the appropriate stakeholders.
Erik Bakker 30.1 81
82 == 5. Suggested Additional Readings ==
83
dfirdausy 63.34 84 If you are interested in this topic and want more information, please read the help text provided by eMagiz and read the following microlearning:
CarlijnKokkeler 59.1 85 * [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
86 ** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
87 *** [[Standard Alerting eMagiz (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]]
CarlijnKokkeler 60.1 88 * [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
89 ** [[Alerting (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.WebHome||target="blank"]]
90 *** [[Setting up notifications (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3||target="blank"]]
dfirdausy 63.36 91 * [[Error Alerting (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22error+alerting%22||target="blank"]]
Erik Bakker 17.1 92 )))((({{toc/}}))){{/container}}{{/container}}