Changes for page Customize Queue Alerting

Last modified by Danniar Firdausy on 2024/09/04 15:45

From version 57.3
edited by Danniar Firdausy
on 2024/07/25 16:21
Change comment: There is no comment for this version
To version 57.9
edited by Danniar Firdausy
on 2024/07/29 12:10
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will focus on how you can customize your queue alerts by configuring the trigger conditions and thresholds, which raise an alert and notify people when those points are passed. Should you want to learn more about the standard alerting that eMagiz offers, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]].
2 +In this microlearning, we will focus on how you can customize your queue alerts by configuring the trigger conditions and thresholds, which raise an alert and notify people when those points are passed. Should you want to learn more about the standard alerting that eMagiz offers or the general concept of eMagiz Queue Alerting, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]].
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -23,14 +23,13 @@
23 23  * Recipients are defined on the queue level.
24 24  
25 25  == 3. Queue Alerting ==
26 -=== 3.1 Queue Alerting Overview ===
27 -In principle, queue alerting refers to the configuration of alerts that work by applying a uniform set of triggers to all queues in your model. By queues here, we mean all queues within your model that are generated by eMagiz. Out-of-the-box, eMagiz provides the default values that are suitable for the topology of each of your model environments (Testing-Acceptance-Production). By topology here, we refer whether your environment is running on single-lane or double-lane setup. In the screenshot below, you can find the overview of your queue alerts by navigating to Manage -> Alerting -> Triggers.
26 +As discussed in the previous [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]], queue alerting refers to the configuration of alerts that work by applying a uniform set of triggers to all queues in your model.
28 28  
29 29  [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-manage-alerting-in-emagiz-queue-alerts-overview.png]]
30 30  
31 -Here, you will find all the queues that are generated by eMagiz currently existing within your model, along with the trigger conditions and thresholds that are applied to each of these queues. In the following sections, we will discuss how you can tune these queue triggers to your needs.
30 +Here, when you navigate to Manage->Alerting->Triggers, you will find all the queues that are generated by eMagiz currently existing within your model, along with the trigger conditions and thresholds that are applied to each of these queues. In the following sections, we will discuss how you can tune these queue triggers to your needs.
32 32  
33 -=== 3.2 Customize Queue Alerting ===
32 +=== 3.1 Customize Queue Alerting ===
34 34  
35 35  To customize these queue triggers to better suit your needs, you can click the edit buttons (green paper and pencil buttons) located at the end of each queue trigger. By doing so, you will get a pop-up page that allows you to further customize the conditions and thresholds of your queue triggers, which will be discussed in the following.
36 36  
... ... @@ -47,9 +47,9 @@
47 47  * **Inactivity check**
48 48  [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-inactivity-check.png]]
49 49  
50 -{{info}}This trigger checks whether a particular queue receives at least one message regularly or within the specified time frame. With this trigger, you specify whether you want to 'always' have the check running everyday or only during a specified time range. Additionally, you can specify the instructions to be included in email notifications sent to recipients and in the alert message displayed in the Manage->Alerting->Alerts.
51 -* If you select the "Always" option, the next step is to configure the "Expect a message every" period. This is useful if you want to be notified when your queue has not received at least one message within a specified time frame, such as a day or more.
52 -* If you select the "During time range" option, you can specify the days of the week and the starting time for the trigger to evaluate the queue. You will also need to specify the duration for which the trigger will evaluate and how frequently within that duration the queue should expect at least one message. Note that the "Expect a message every" setting must allow for at least two occurrences within the specified duration. If the queue receives a message before the end of the "Expect a message every" period, the timer will reset. This means that this trigger can produce two or more alerts a day.
49 +{{info}}This trigger checks whether a particular queue receives at least one message regularly or within the specified time frame. With this trigger, you specify whether you want to 'always' have the check running everyday or only during a specified time range. If the queue receives a message within a specified time frame (i.e., time frame specified in the 'Expect a message every'), then the timer will reset and the next evaluation interval will start. Therefore, this trigger can produce two or more alerts a day if that setting is set to less than half a day. Similar to the other triggers, you can specify the instructions to be included in email notifications sent to recipients and in the alert message displayed in the Manage->Alerting->Alerts.
50 +* If you select the "Always" option, the next step is to configure the "Expect a message every" period. This is useful if you want to run the check every day and be notified when your queue has not received at least one message within a specified time frame, such as within an hour, a day or more.
51 +* If you select the "During time range" option, you can specify the days of the week and the starting time for the trigger to evaluate the queue. You will also need to specify the duration for which the trigger will evaluate and how frequently within that duration the queue should expect at least one message. Note that for this option, the "Expect a message every" setting must allow for at least two occurrences within the specified duration.
53 53  * In the example above, the trigger is set to evaluate from Monday to Friday, 9:00 to 17:00, and expects a message every four hours, an alert will be sent if no message is received by 13:00. However, if a message is received at 11:00, then the timer resets, and the next check will be at 15:00. If no message is received by then, an alert will be sent. Consequently, due to the configuration of expects a message every four hours, and considering that there are only two hours left until the configured 17:00, the trigger for the remaining two hours will not be executed.{{/info}}
54 54  
55 55  * **Periodic activity check**
... ... @@ -62,7 +62,7 @@
62 62  
63 63  Upon saving, these custom values will apply immediately, putting the new check into effect. Additionally, you will notice that the "Settings" status of the queue trigger you just customized has changed from "Default" to "Custom".
64 64  
65 -=== 3.3 Customize Default Values ===
64 +=== 3.2 Customize Default Values ===
66 66  
67 67  Next to customize the trigger conditions and thresholds for each queue, you can also modify the default values for all of your queue triggers. Changes to the default values will only apply to queue triggers that are set to use the default values, and not to those you have already customized. To modify the default values configured by eMagiz, you can click the "Configure defaults" button at the top of the queue trigger list.
68 68  
... ... @@ -80,5 +80,5 @@
80 80  
81 81  If you are interested in this topic and want more information, please read the help text provided by eMagiz and read the following microlearning.
82 82  * [[Setting up notification>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3||target="blank"]]
83 -
82 +* [[Standard Alerting eMagiz>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]]
84 84  )))((({{toc/}}))){{/container}}{{/container}}