Skip to Content

Changes for page Dynamic Alerting

Last modified by Danniar Firdausy on 2024/11/19 11:08
From version 39.7
edited by Danniar Firdausy
on 2024/07/29 14:03
Change comment: There is no comment for this version
To version 32.1
edited by Erik Bakker
on 2023/02/06 09:05
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,21 +20,14 @@
20 20  ** Queue consumers
21 21  ** Messages in queue
22 22  ** Queue throughput
23 --->
24 -{{/html}}
25 -* There are four trigger options
26 -** Error message
27 -** Log message
28 -** Messages added to topic
29 -** Topic consumer messages behind
30 30  * On the trigger level, the recipients are defined
31 31  * On the trigger level, the congestion control is defined
32 32  
33 33  == 3. Dynamic Alerting ==
34 34  
35 -To enhance the observability of your integration landscape while running in the current generation runtime architecture, we provide a functionality in the 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.
26 +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.
36 36  
37 -We offer alerting on seven types.
28 +We offer alerting on five types.
38 38  
39 39  * Error message
40 40  * Log message
... ... @@ -41,8 +41,6 @@
41 41  * Queue consumers
42 42  * Messages in queue
43 43  * Queue throughput
44 -* Messages added to topic
45 -* Topic consumer messages behind
46 46  
47 47  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
48 48  
... ... @@ -94,8 +94,14 @@
94 94  
95 95  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.
96 96  
97 -{{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]]
98 98  
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 +
99 99  Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
100 100  
101 101  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]]
... ... @@ -102,42 +102,30 @@
102 102  
103 103  === 3.5 Queue througput ===
104 104  
105 -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.
106 106  
107 107  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
108 108  
109 109  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.
110 110  
111 -{{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]]
112 112  
113 -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.
114 114  
115 -[[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]]
116 116  
117 -=== 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}}
118 118  
119 -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.
120 120  
121 -[[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]]
122 122  
123 -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.
124 -
125 -{{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}}
126 -
127 127  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.
128 128  
129 -=== 3.7 Topic consumer lag ===
120 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
130 130  
131 -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 ===
132 132  
133 -{{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}}
134 -
135 -Once filled in, the solution should look similar as follows.
136 -
137 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
138 -
139 -=== 3.8 Recipient(s) configuration ===
140 -
141 141  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.
142 142  
143 143  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
... ... @@ -144,7 +144,7 @@
144 144  
145 145  {{info}}Note that when you define multiple external recipients, you need to separate each email address with a comma to make it work.{{/info}}
146 146  
147 -=== 3.9 Congestion control configuration ===
130 +=== 3.7 Congestion control configuration ===
148 148  
149 149  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.
150 150  
... ... @@ -154,14 +154,12 @@
154 154  
155 155  == 4. Key takeaways ==
156 156  
157 -* There are seven trigger options
140 +* There are five trigger options
158 158  ** Error message
159 159  ** Log message
160 160  ** Queue consumers
161 161  ** Messages in queue
162 162  ** Queue throughput
163 -** Messages added to topic
164 -** Topic consumer messages behind
165 165  * On the trigger level, the recipients are defined
166 166  * On the trigger level, the congestion control is defined
167 167  * Default configuration of the congestion control is sufficient in most cases