Skip to Content

Changes for page Customize Queue Alerting

Last modified by Danniar Firdausy on 2024/09/04 15:45
From version 29.1
edited by Erik Bakker
on 2023/02/03 10:49
Change comment: There is no comment for this version
To version 43.31
edited by Danniar Firdausy
on 2024/07/22 16:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Dynamic Alerting
1 +Customize Queue Alerting
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.dfirdausy
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
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||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, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]]. Note that the queue alerting explained in this page is only applicable for eMagiz models that are running the current generation runtime architecture.
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -6,62 +6,68 @@
6 6  == 1. Prerequisites ==
7 7  
8 8  * Basic knowledge of the eMagiz platform
9 +* Basic knowledge of alerting in the eMagiz platform
9 9  
10 10  == 2. Key concepts ==
11 11  
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
13 +This microlearning focuses on customizing the queue alerts for each environment (i.e., Testing-Acceptance-Production) in your model. 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.
14 14  
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
15 +* eMagiz applies the same set of triggers to all JMS queues
16 +* There are four queue trigger options that eMagiz currently provides:
17 +** Consumers check
18 +** Queue load check
19 +** Inactivity check
20 +** Periodic activity check
21 +* Recipients are defined on the queue level.
18 18  
19 -== 3. Linking Tag(s) to Trigger(s) ==
23 +== 3. Queue Alerting ==
24 +=== 3.1 Queue Alerting Overview ===
25 +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 that are generated by eMagiz and existing in the Create phase of your model. 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.
20 20  
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:
27 +[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-manage-alerting-in-emagiz-queue-alerts-overview.png]]
22 22  
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
29 +Here, you will find all the queues that are generated by eMagiz and currently existing in the Create phase of 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.
26 26  
27 -To link tag(s) to trigger(s) you navigate to Manage -> Alerting -> Triggers
31 +=== 3.2 Customize Queue Alerting ===
28 28  
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:
33 +To customize these queue triggers to better suit your needs, you can click the edit buttons (green paper and pencil buttons) that find 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.
30 30  
31 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-data-measurements.png]]
35 + *** Consumers check **
36 + [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue.png]]
37 +This trigger checks how many processes (consumers) are subscribing to and retrieving messages from a particular queue over the last 10 minutes. It evaluates whether the number of consumers meets the specified threshold. If the number of consumers falls below the "Expected consumers" value, 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.
32 32  
33 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-log-entry.png]]
39 + * Queue load check
40 + [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-queue-load-check.png]]
41 +This trigger checks how many messages are produced on a particular queue and not yet retrieved by any consumers over the last 10 minutes. It evaluates whether the number of messages on the queue is below the specified threshold. If the number of messages is greater than the "Max messages queued" value, 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 more than 100 messages being queued during a duration of 10 minutes.
42 +
43 + * Inactivity check
44 + [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-inactivity-check.png]]
45 + aa
46 +
47 + * Periodic activity check
48 + [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-periodic-activity-check.png]]
49 + aa
34 34  
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.
36 36  
37 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-no-tag.png]]
52 +=== 3.3 Customize Default Values ===
38 38  
39 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-select-tag.png]]
54 +Next to that, you can also customize the default values of your queue triggers to better suit the requirements of each environment of your model, as well as modify the trigger conditions and thresholds for each queue. To customize the default values that eMagiz has configured by default, you can click the "Configure defaults" button on top of this list. You will see
40 40  
41 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-one-tag.png]]
56 +The "Configure defaults" button above the list of these queue triggers (or "View defaults" depending if your account does not have the edit rights on Manage) to customize the default values of your queue triggers
42 42  
43 -When you are happy with your selection you can press Save on trigger level and eMagiz will link the tag to the trigger.
58 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue-load-check.png]]
44 44  
45 -== 4. Assignment ==
46 46  
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.
61 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-inactivity-check-periodic-activity-check.png]]
49 49  
50 -== 5. Key takeaways ==
63 +== 4. Key takeaways ==
51 51  
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
65 +* a
66 +* b
67 +* c
56 56  
57 -== 6. Suggested Additional Readings ==
69 +== 5. Suggested Additional Readings ==
58 58  
59 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
71 +If you are interested in this topic and want more information, please read the help text provided by eMagiz.
60 60  
61 -== 7. Silent demonstration video ==
62 -
63 -This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
64 -
65 -{{video attachment="novice-alerting-linking-tags-to-triggers.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
66 -
67 67  )))((({{toc/}}))){{/container}}{{/container}}