Changes for page Dynamic Alerting

Last modified by Danniar Firdausy on 2024/11/19 11:08

From version 39.2
edited by Danniar Firdausy
on 2024/07/29 13:59
Change comment: There is no comment for this version
To version 34.1
edited by Erik Bakker
on 2023/02/07 13:41
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dfirdausy
1 +XWiki.ebakker
Content
... ... @@ -9,11 +9,9 @@
9 9  
10 10  == 2. Key concepts ==
11 11  
12 -This microlearning centers on configuring dynamic alerting based on triggers you can define as a user.
12 +This microlearning centers configuring dynamic alerting based on triggers you can define as a user.
13 13  By defining, we mean: Specifying based on what triggers an alert needs to be raised.
14 14  
15 -{{html}}
16 -<!--
17 17  * There are five trigger options
18 18  ** Error message
19 19  ** Log message
... ... @@ -20,16 +20,6 @@
20 20  ** Queue consumers
21 21  ** Messages in queue
22 22  ** Queue throughput
23 --->
24 -{{/html}}
25 -
26 -* There are five trigger options
27 -** Error message
28 -** Log message
29 -** Queue consumers
30 -** Messages in queue
31 -** Queue throughput
32 -
33 33  * On the trigger level, the recipients are defined
34 34  * On the trigger level, the congestion control is defined
35 35  
... ... @@ -37,7 +37,7 @@
37 37  
38 38  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.
39 39  
40 -We offer alerting on seven types.
28 +We offer alerting on five types.
41 41  
42 42  * Error message
43 43  * Log message
... ... @@ -44,8 +44,6 @@
44 44  * Queue consumers
45 45  * Messages in queue
46 46  * Queue throughput
47 -* Messages added to topic
48 -* Topic consumer messages behind
49 49  
50 50  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
51 51  
... ... @@ -97,8 +97,14 @@
97 97  
98 98  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.
99 99  
100 -{{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}}
86 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-specific-queues.png]]
101 101  
88 +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.
89 +
90 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
91 +
92 +{{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}}
93 +
102 102  Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
103 103  
104 104  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]]
... ... @@ -105,42 +105,30 @@
105 105  
106 106  === 3.5 Queue througput ===
107 107  
108 -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.
100 +On top of the "static" alert that is autogenerated by eMagiz on Error messages, 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.
109 109  
110 110  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
111 111  
112 112  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.
113 113  
114 -{{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}}
106 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-specific-queues.png]]
115 115  
116 -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.
108 +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.
117 117  
118 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
110 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
119 119  
120 -=== 3.6 Messages added to topic ===
112 +{{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}}
121 121  
122 -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.
114 +Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
123 123  
124 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-all-topics.png]]
116 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-queue-selection-result.png]]
125 125  
126 -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.
127 -
128 -{{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}}
129 -
130 130  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.
131 131  
132 -=== 3.7 Topic consumer lag ===
120 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
133 133  
134 -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.
122 +=== 3.6 Recipient(s) configuration ===
135 135  
136 -{{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}}
137 -
138 -Once filled in, the solution should look similar as follows.
139 -
140 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
141 -
142 -=== 3.8 Recipient(s) configuration ===
143 -
144 144  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.
145 145  
146 146  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
... ... @@ -147,7 +147,7 @@
147 147  
148 148  {{info}}Note that when you define multiple external recipients, you need to separate each email address with a comma to make it work.{{/info}}
149 149  
150 -=== 3.9 Congestion control configuration ===
130 +=== 3.7 Congestion control configuration ===
151 151  
152 152  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.
153 153  
... ... @@ -157,14 +157,12 @@
157 157  
158 158  == 4. Key takeaways ==
159 159  
160 -* There are seven trigger options
140 +* There are five trigger options
161 161  ** Error message
162 162  ** Log message
163 163  ** Queue consumers
164 164  ** Messages in queue
165 165  ** Queue throughput
166 -** Messages added to topic
167 -** Topic consumer messages behind
168 168  * On the trigger level, the recipients are defined
169 169  * On the trigger level, the congestion control is defined
170 170  * Default configuration of the congestion control is sufficient in most cases