Changes for page Customize Queue Alerting

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

From version 43.10
edited by Danniar Firdausy
on 2024/07/22 13:18
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,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"]]. Note that the queue alerting explained in this page is only applicable for eMagiz models that are running the current generation runtime architecture.
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,44 +6,62 @@
6 6  == 1. Prerequisites ==
7 7  
8 8  * Basic knowledge of the eMagiz platform
9 -* Basic knowledge of alerting in the eMagiz platform
10 10  
11 11  == 2. Key concepts ==
12 12  
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.
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
14 14  
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.
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
22 22  
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.
19 +== 3. Linking Tag(s) to Trigger(s) ==
26 26  
27 -[[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:
28 28  
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. Next to that, you can also find edit buttons (green paper and pencil buttons) at the end of each queue trigger to customize these queue triggers, as well as 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. 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
30 30  
31 -=== 3.2 Customize Queue Alerting ===
27 +To link tag(s) to trigger(s) you navigate to Manage -> Alerting -> Triggers
32 32  
33 -To customize
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:
34 34  
35 -=== 3.3 Customize Default Values ===
31 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-data-measurements.png]]
36 36  
37 -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
33 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-log-entry.png]]
38 38  
39 -== 4. Key takeaways ==
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.
40 40  
41 -* a
42 -* b
43 -* c
37 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-no-tag.png]]
44 44  
45 -== 5. Suggested Additional Readings ==
39 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-select-tag.png]]
46 46  
47 -If you are interested in this topic and want more information, please read the help text provided by eMagiz.
41 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-one-tag.png]]
48 48  
43 +When you are happy with your selection you can press Save on trigger level and eMagiz will link the tag to the trigger.
44 +
45 +== 4. Assignment ==
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.
49 +
50 +== 5. Key takeaways ==
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
56 +
57 +== 6. Suggested Additional Readings ==
58 +
59 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
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 +
49 49  )))((({{toc/}}))){{/container}}{{/container}}