Skip to Content

Changes for page Customize Queue Alerting

Last modified by Danniar Firdausy on 2024/09/04 15:45
From version 15.1
edited by eMagiz
on 2022/05/22 21:23
Change comment: There is no comment for this version
To version 40.3
edited by Danniar Firdausy
on 2024/07/18 13:27
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Customize Queue Alerting
Parent
... ... @@ -1,0 +1,1 @@
1 +Main.eMagiz Academy.Microlearnings.Novice.Alerting.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.marijn
1 +XWiki.dfirdausy
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,91 +1,167 @@
1 -{{html wiki="true"}}
2 -<div class="ez-academy">
3 - <div class="ez-academy_body">
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.
4 4  
5 -<div class="doc">
4 +. 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"]].
6 6  
6 +Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7 7  
8 +== 1. Prerequisites ==
8 8  
9 -= Linking Tag(s) to Trigger(s) =
10 +* Basic knowledge of the eMagiz platform
10 10  
11 -In this microlearning, we will focus on how you can link your alerting tag(s) to alerting trigger(s).
12 -In a previous microlearning we already discussed parts of this. In this microlearning we will zoom in on the Trigger section of Alerting.
12 +== 2. Key concepts ==
13 13  
14 -Should you have any questions, please contact academy@emagiz.com.
14 +This microlearning centers configuring dynamic alerting based on triggers you can define as a user.
15 +By defining, we mean: Specifying based on what triggers an alert needs to be raised.
15 15  
16 -* Last update: April 1th 2021
17 -* Required reading time: 5 minutes
17 +* There are five trigger options
18 +** Error message
19 +** Log message
20 +** Queue consumers
21 +** Messages in queue
22 +** Queue throughput
23 +* On the trigger level, the recipients are defined
24 +* On the trigger level, the congestion control is defined
18 18  
19 -== 1. Prerequisites ==
26 +== 3. Dynamic Alerting ==
20 20  
21 -* Basic knowledge of the eMagiz platform
28 +To enhance the observability of your integration landscape while running in the 3rd generation runtime architecture, we have added a new feature to our Manage phase called "Dynamic Alerts." You can access this functionality via the "Alerting" menu in Manage. Then, with the help of the "Trigger" overview, you can view all triggers in your environment. On the top of the list, you will see all [["static" alerts>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]] as defined by eMagiz below that you will see all "dynamic" alerts that you and your fellow team members (with sufficient rights) can view, edit and delete.
22 22  
23 -== 2. Key concepts ==
30 +We offer alerting on seven types.
24 24  
25 -This microlearning centers around linking tag(s) to trigger(s).
26 -With linking, we mean: Categorize a certain trigger with the help of tag functionality
32 +* Error message
33 +* Log message
34 +* Queue consumers
35 +* Messages in queue
36 +* Queue throughput
37 +* Messages added to topic
38 +* Topic consumer messages behind
27 27  
28 -* Make tags descriptive in nature
29 -* Re-use tags over multiple triggers that have the same aim
30 -* In case of a start, daily and end alert use the same tag for all of them
40 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
31 31  
42 +First, we will discuss the configuration of each trigger type. Subsequently, we will discuss defining which recipients will be notified and how to alter the default congestion control settings (as this is the same for each trigger type).
32 32  
44 +=== 3.1 Error message ===
33 33  
34 -== 3. Linking Tag(s) to Trigger(s) ==
46 +On top of the "static" alert that is autogenerated by eMagiz on Error messages, you can add additional "dynamic" alerts that only trigger when an error message is raised for which a specific header contains a particular value. This is most likely relevant when a specific error message with certain characteristics (i.e., a particular header value) needs to be sent to a different set of recipients.
35 35  
36 -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:
48 +To define the trigger, fill in the header's name and the expected value. On top of that, you can fill in a description that will be added to the alert received via email. Once this is filled in, the configuration could look as follows.
37 37  
38 -* Make tags descriptive in nature
39 -* Re-use tags over multiple triggers that have the same aim
40 -* In case of a start, daily and end alert use the same tag for all of them
50 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-error-message-configuration.png]]
41 41  
42 -To link tag(s) to trigger(s) you navigate to Manage -> Alerting -> Triggers
52 +=== 3.2 Log message ===
43 43  
44 -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:
54 +On top of the "static" alert that is autogenerated by eMagiz on Log messages, you can add additional "dynamic" alerts that only trigger when a log message contains a specific phrase. This is likely when you log something on which you want to alert when it happens.
45 45  
46 -<p align="center">[[image:novice-alerting-linking-tags-to-triggers--example-trigger-detail-data-measurements.png||]]</p>
56 +To define the trigger, fill in the phrase you want to check. On top of that, you can fill in a description that will be added to the alert received via email. Once this is filled in, the configuration could look as follows.
47 47  
48 -<p align="center">[[image:novice-alerting-linking-tags-to-triggers--example-trigger-detail-log-entry.png||]]</p>
58 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
49 49  
50 -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.
60 +=== 3.3 Queue consumers ===
51 51  
52 -<p align="center">[[image:novice-alerting-linking-tags-to-triggers--example-trigger-detail-no-tag.png||]]</p>
62 +On top of the "static" alert that is autogenerated by eMagiz on Queue consumers, you can add additional "dynamic" alerts that only trigger when the number of consumers on a (specific) set of queues is below a certain threshold.
53 53  
54 -<p align="center">[[image:novice-alerting-linking-tags-to-triggers--example-trigger-detail-select-tag.png||]]</p>
64 +To define the trigger, determine the threshold you want to check (i.e., 2). Subsequently, specify whether on which queues (or all queues) you want eMagiz to check for this condition. No further action is needed if you want to check on all queues.
55 55  
56 -<p align="center">[[image:novice-alerting-linking-tags-to-triggers--example-trigger-detail-one-tag.png||]]</p>
66 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-all-queues.png]]
57 57  
58 -When you are happy with your selection you can press Save on trigger level and eMagiz will link the tag to the trigger.
68 +You can uncheck the checkbox if you want to check on a specific (set of) queue(s). As a result, the "Add" and "Remove" buttons are displayed by eMagiz, through which you can add and remove queues to the trigger.
59 59  
60 -===== Practice =====
70 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-specific-queues.png]]
61 61  
62 -== 4. Assignment ==
72 +When you press the "Add" button, a new pop-up will appear through which you can select the queues for which you want the trigger to be activated. In this pop-up, you can choose one (or more) queues and press the "Select" button to add them to the trigger.
63 63  
64 -Link an (extra) tag to a trigger.
65 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
74 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
66 66  
67 -== 5. Key takeaways ==
76 +{{info}}Note that when you want to select multiple queues at once, you cannot press "Enter" to Save your selection. In this case, you need to press the "Select" button to save your choice.{{/info}}
68 68  
69 -* Assist in creating a common language
70 -* Make tags descriptive in nature
71 -* Re-use tags over multiple triggers that have the same aim
72 -* In case of a start, daily and end alert use the same tag for all of them
78 +Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
73 73  
80 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection-result.png]]
74 74  
82 +=== 3.4 Messages in queue ===
75 75  
76 -== 6. Suggested Additional Readings ==
84 +On top of the "static" alert that is autogenerated by eMagiz on Messages in a queue, you can add additional "dynamic" alerts that only trigger when a queue holds more than X messages. Logically, the X can be determined by the user. Subsequently, define whether on which queues (or all queues) you want eMagiz to check for this condition. No further action is needed if you want to check on all queues.
77 77  
78 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
86 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-all-queues.png]]
79 79  
80 -== 7. Silent demonstration video ==
88 +You can uncheck the checkbox if you want to check on a specific (set of) queue(s). As a result, the "Add" and "Remove" buttons are displayed by eMagiz, through which you can add and remove queues to the trigger.
81 81  
82 -This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
90 +{{info}}This process of adding and removing specific queues works identically, as explained in the section on Queue consumers.[[Queue consumers.>>||anchor="H3.3Queueconsumers"]]{{/info}}
83 83  
84 -<iframe width="1280" height="720" src="../../vid/microlearning/novice-alerting-linking-tags-to-triggers.mp4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
92 +Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
85 85  
86 -</div>
94 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]]
87 87  
88 -</div>
89 -</div>
96 +=== 3.5 Queue througput ===
90 90  
91 -{{/html}}
98 +For this category you can add additional "dynamic" alerts that only trigger when the throughput on one or more queues is more or less than X messages per Y minutes. Subsequently, define whether on which queues (or all queues) you want eMagiz to check for this condition. No further action is needed if you want to check on all queues.
99 +
100 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
101 +
102 +You can uncheck the checkbox if you want to check on a specific (set of) queue(s). As a result, the "Add" and "Remove" buttons are displayed by eMagiz, through which you can add and remove queues to the trigger.
103 +
104 +{{info}}This process of adding and removing specific queues works identically, as explained in the section on Queue consumers.[[Queue consumers.>>||anchor="H3.3Queueconsumers"]]{{/info}}
105 +
106 +For this trigger, additional criteria can be configured that allow you to define when eMagiz needs to validate this configuration (i.e., Occurence). With the help of this configuration option, you can specify when the trigger needs to be evaluated. An example could be only on Monday between 04:00 AM and 05:00 AM.
107 +
108 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
109 +
110 +=== 3.6 Messages added to topic ===
111 +
112 +For this category, you can add additional "dynamic" alerts. These alerts only trigger when the messages added to one or more topic is less than X messages per Y minutes. On top of the number of messages (X) and the timeframe (Y), you can define whether to validate this on a specific topic or all topics. Note that the default configuration is that the alert applies to all topics.
113 +
114 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-all-topics.png]]
115 +
116 +You can uncheck the checkbox to check on a specific (set of) topic(s). As a result, the "Add" and "Remove" buttons are displayed by eMagiz, through which you can add and remove topics to the trigger.
117 +
118 +{{info}}This process of adding and removing specific topics works identically, as explained in the section on Queue consumers.[[Queue consumers.>>||anchor="H3.3Queueconsumers"]]{{/info}}
119 +
120 +For this trigger, additional criteria can be configured that allow you to define when eMagiz needs to validate this configuration (i.e., Occurence). With the help of this configuration option, you can specify when the trigger needs to be evaluated. An example could be only on Monday between 04:00 AM and 05:00 AM.
121 +
122 +=== 3.7 Topic consumer lag ===
123 +
124 +For this category, you can add additional "dynamic" alerts. These alerts only trigger when one (or more) consumer groups lag by X messages on one (or more) topic(s). Note that the default configuration is that you, as a user, need to specify for which topic(s) the alert applies, as consumers' behavior can vary widely.
125 +
126 +{{info}}This process of adding and removing specific topics works identically, as explained in the section on Queue consumers.[[Queue consumers.>>||anchor="H3.3Queueconsumers"]]{{/info}}
127 +
128 +Once filled in, the solution should look similar as follows.
129 +
130 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
131 +
132 +=== 3.8 Recipient(s) configuration ===
133 +
134 +You can select your recipients when you switch from the "Trigger" to the "Output" tab. In this overview, you can choose both eMagiz users and external recipients.
135 +
136 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
137 +
138 +{{info}}Note that when you define multiple external recipients, you need to separate each email address with a comma to make it work.{{/info}}
139 +
140 +=== 3.9 Congestion control configuration ===
141 +
142 +In the same "Output" tab, you can also define the congestion control configuration. The default configuration is that congestion control will be activated once more than ten alerts are triggered in the last ten minutes. So should you want to reduce this number, you can do so here.
143 +
144 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]]
145 +
146 +{{warning}}Note that we advise only reducing the number under the congestion control if the ten default is too high. We do **not** advise deactivating the congestion control as this can cause an explosion in the number of received notifications.{{/warning}}
147 +
148 +== 4. Key takeaways ==
149 +
150 +* There are seven trigger options
151 +** Error message
152 +** Log message
153 +** Queue consumers
154 +** Messages in queue
155 +** Queue throughput
156 +** Messages added to topic
157 +** Topic consumer messages behind
158 +* On the trigger level, the recipients are defined
159 +* On the trigger level, the congestion control is defined
160 +* Default configuration of the congestion control is sufficient in most cases
161 +* When entering multiple external recipients, ensure each email address is separated with a comma
162 +
163 +== 5. Suggested Additional Readings ==
164 +
165 +If you are interested in this topic and want more information, please read the help text provided by eMagiz.
166 +
167 +)))((({{toc/}}))){{/container}}{{/container}}
novice-alerting-linking-tags-to-triggers--example-trigger-detail-data-measurements.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.marijn
Size
... ... @@ -1,1 +1,0 @@
1 -31.8 KB
Content
novice-alerting-linking-tags-to-triggers--example-trigger-detail-log-entry.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.marijn
Size
... ... @@ -1,1 +1,0 @@
1 -12.7 KB
Content
novice-alerting-linking-tags-to-triggers--example-trigger-detail-no-tag.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.marijn
Size
... ... @@ -1,1 +1,0 @@
1 -6.3 KB
Content
novice-alerting-linking-tags-to-triggers--example-trigger-detail-one-tag.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.marijn
Size
... ... @@ -1,1 +1,0 @@
1 -9.1 KB
Content
novice-alerting-linking-tags-to-triggers--example-trigger-detail-select-tag.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.marijn
Size
... ... @@ -1,1 +1,0 @@
1 -11.7 KB
Content