Skip to Content

Changes for page Customize Queue Alerting

Last modified by dfirdausy on 2024/09/04 15:45
From version 57.13
edited by dfirdausy
on 2024/07/29 12:21
Change comment: There is no comment for this version
To version 28.1
edited by Erik Bakker
on 2023/02/03 10:48
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Customize Queue Alerting
1 +Dynamic Alerting
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dfirdausy
1 +XWiki.ebakker
Content
... ... @@ -1,85 +1,67 @@
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 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"]].
2 +In this microlearning, we will focus on how you can configure your own dynamic alerting by setting up triggers on events and notifiying people on it. Should you want to learn more on 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.WebHome||target="blank"]]
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 -{{info}}Note that this documentation explains the latest design of eMagiz Queue Alerting that is released on 1st of August 2024 and the Queue Alerting explained in this page is only applicable for eMagiz models that are running the [[current generation runtime architecture>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]{{/info}}
7 -
8 8  == 1. Prerequisites ==
9 9  
10 10  * Basic knowledge of the eMagiz platform
11 -* Basic knowledge of alerting in the eMagiz platform
12 12  
13 13  == 2. Key concepts ==
14 14  
15 -This microlearning focuses on customizing the queue alerts that are existing in each of the environment of your model (i.e., Testing-Acceptance-Production). By customizing we mean further configuring the trigger conditions and thresholds of your queues from the general default settings provided by eMagiz, so they better suit your needs and requirements.
12 +This microlearning centers around linking tag(s) to trigger(s).
13 +With linking, we mean: Categorize a certain trigger with the help of tag functionality
16 16  
17 -* eMagiz applies the same set of triggers to all queues.
18 -* There are four queue trigger options that eMagiz currently provides:
19 -** Consumers check
20 -** Queue load check
21 -** Inactivity check
22 -** Periodic activity check
23 -* Recipients are defined on the queue level.
15 +* Make tags descriptive in nature
16 +* Re-use tags over multiple triggers that have the same aim
17 +* In case of a start, daily and end alert use the same tag for all of them
24 24  
25 -== 3. Queue Alerting ==
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.
19 +== 3. Linking Tag(s) to Trigger(s) ==
27 27  
28 -[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-manage-alerting-in-emagiz-queue-alerts-overview.png]]
21 +In our previous dalliance with this subject we already discussed parts of what we will discuss in this microlearning. This microlearning is mainly meant to reiterate the importance of using proper tags when setting up your alerting. Linking the correct tag(s) to your trigger(s) will help you to clarify how the alerting structure for your project is set up. This is not only nice when you want to revisit the alerting section but it is also very usefull in communication with the business and with a support desk. This way you can create a common truth surrounding a common language. Key parts in achieving this are:
29 29  
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.
23 +* Make tags descriptive in nature
24 +* Re-use tags over multiple triggers that have the same aim
25 +* In case of a start, daily and end alert use the same tag for all of them
31 31  
32 -=== 3.1 Customize Default Values ===
27 +To link tag(s) to trigger(s) you navigate to Manage -> Alerting -> Triggers
33 33  
34 -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.
29 +In this overview you can simply select a specific trigger to see the detailed configuration of the trigger. Depending on the type of trigger that you open the avaiable tabs within the pop-up and the information shown in the pop-up can differ. Below we show two distinct examples:
35 35  
36 -{{info}}Note that, if your account does not have an edit rights in Manage for a specific environment, you will see "View defaults" button instead.{{/info}}
31 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-data-measurements.png]]
37 37  
38 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue-load-check.png]]
33 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-log-entry.png]]
39 39  
40 -Here, you will get a pop-up page quite resembling to the one when you customize the triggers for individual queues. The difference is that here you have the button to Reset the default values to the default values from eMagiz and the Save button is Update defaults, which will apply the default values that you configured to all queue triggers that are set to use the default values. Similar to customizing individual queue triggers, upon saving, the new default values will be put into effect immediately.
35 +As you can see from these examples is that the number of tabs within the pop-up differ. The first tab is were the configuration of the trigger happens. In all the other tabs you need to link the tag(s) to the trigger. To do so simply press Add in one of these tabs, search for the Tag you want to link to this trigger, select it and press Select.
41 41  
42 -=== 3.2 Customize Queue Alerting ===
37 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-no-tag.png]]
43 43  
44 -Next to customizing the default values for each queue triggers, you can also modify the trigger configurations for individual queues. 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.
39 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-select-tag.png]]
45 45  
46 -* **Consumers check**
47 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue.png]]
41 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-one-tag.png]]
48 48  
49 -{{info}}This trigger checks how many processes (consumers) are subscribing to and retrieving messages from a particular queue over the last ten minutes. It evaluates whether the number of consumers meets the specified threshold. If the number of consumers falls consistently **below** the "Expected consumers" value for a period of ten minutes, an alert is generated. You can customize this threshold as needed. 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.{{/info}}
43 +When you are happy with your selection you can press Save on trigger level and eMagiz will link the tag to the trigger.
50 50  
51 -* **Queue load check**
52 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-queue-load-check.png]]
45 +== 4. Assignment ==
53 53  
54 -{{info}}This trigger checks how many messages are produced on a particular queue and not yet retrieved by any consumers over the last ten minutes. It evaluates whether the number of messages on the queue is below the specified threshold. If the number of messages is consistently **greater** than the "Max messages queued" value for a period of ten minutes, an alert is generated. You can customize this threshold as needed. 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. It is important to note that if high bursts of messages occur regularly (e.g., during nightly batch processing, 1000 messages are expected to be produced to a certain queue), then setting a higher threshold (e.g., 1000 Max messages queued) can prevent false-positive alerts caused by the default configuration.{{/info}}
47 +Link an (extra) tag to a trigger.
48 +This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
55 55  
56 -* **Inactivity check**
57 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-inactivity-check.png]]
50 +== 5. Key takeaways ==
58 58  
59 -{{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.
60 -* 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.
61 -* 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.
62 -* 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}}
52 +* Assist in creating a common language
53 +* Make tags descriptive in nature
54 +* Re-use tags over multiple triggers that have the same aim
55 +* In case of a start, daily and end alert use the same tag for all of them
63 63  
64 -* **Periodic activity check**
65 - [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-periodic-activity-check.png]]
57 +== 6. Suggested Additional Readings ==
66 66  
67 -{{info}}This trigger checks whether at least the specified number of messages is received during the specified interval. Similar to the others, you can also specify the instructions to be included in email notifications sent to recipients and in the alert message displayed in Manage->Alerting->Alerts.
68 -* If you enable this trigger, you must also specify the days of the week, the starting time, and the duration for the trigger to evaluate the queue. Additionally, you need to specify the minimum number of messages the queue is expected to receive. If this number is **not** reached, an alert will be generated.
69 -* Unlike the Inactivity check, this Periodic Activity check evaluates only at **the end of each interval** and does **not** reset the timer when the minimum number of messages is reached during the interval. This means that this trigger will not produce more than one alert per day.
70 -* In the example above, the trigger is set to evaluate from Monday to Friday, from 9:00 to 8:45 in the following morning, and expects a minimum of 100 messages within each interval. If the 100 messages are not received by that 8:45 in the next morning, an alert will be sent. Alternatively, if the 100 messages are reached, no alert will be generated for that interval, and the next check will start again at 9:00. For intervals starting on Friday, the next check will begin at 9:00 AM on Monday, as Saturday and Sunday are not included.{{/info}}
59 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
71 71  
72 -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".
61 +== 7. Silent demonstration video ==
73 73  
74 -== 4. Key takeaways ==
63 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
75 75  
76 -* Queue alerting involves setting triggers for all queues in your model, which can be customized for individual queues or modified as default values.
77 -* 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).
78 -* If you want to learn more on how to configure the recipients for the alerts generated from these queue triggers, please check out [[Setting up notification>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3||target="blank"]].
65 +{{video attachment="novice-alerting-linking-tags-to-triggers.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
79 79  
80 -== 5. Suggested Additional Readings ==
81 -
82 -If you are interested in this topic and want more information, please read the help text provided by eMagiz and read the following microlearning.
83 -* [[Setting up notification>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3||target="blank"]]
84 -* [[Standard Alerting eMagiz>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]]
85 85  )))((({{toc/}}))){{/container}}{{/container}}