Skip to Content

Changes for page Dynamic Alerting

Last modified by Danniar Firdausy on 2024/11/19 11:08
From version 39.16
edited by Danniar Firdausy
on 2024/07/29 14:23
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,31 +20,21 @@
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. From there on, you can navigate to the "Other" tab.
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 -Here, 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"]] that are defined by eMagiz (alerts that are non-editable) and below that (alerts that are editable), you will see all "dynamic" alerts that you and your fellow team members (with sufficient rights) can view, edit and delete.
28 +We offer alerting on five types.
38 38  
39 -In this page, we offer alerting on four types.
40 -
41 41  * Error message
42 42  * Log message
43 -* Messages added to topic
44 -* Topic consumer messages behind
32 +* Queue consumers
33 +* Messages in queue
34 +* Queue throughput
45 45  
46 -{{info}}As of the recent eMagiz release, we have moved the configurations for queue triggers (i.e., Queue consumers, Messages in queue, Queue throughput) to another page. Please refer to the [[Customize Queue alerting>>doc:Main.eMagiz Academy.Microlearnings.Novice.Alerting.novice-alerting-customize-queue-alerting.WebHome||target="blank"]] page if you want to learn more on how to customize the triggers for these queues or the default values of these queue triggers.{{/info}}
47 -
48 48  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
49 49  
50 50  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).
... ... @@ -95,8 +95,14 @@
95 95  
96 96  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.
97 97  
98 -{{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]]
99 99  
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 +
100 100  Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
101 101  
102 102  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]]
... ... @@ -103,42 +103,30 @@
103 103  
104 104  === 3.5 Queue througput ===
105 105  
106 -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.
107 107  
108 108  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
109 109  
110 110  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.
111 111  
112 -{{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]]
113 113  
114 -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.
115 115  
116 -[[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]]
117 117  
118 -=== 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}}
119 119  
120 -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.
121 121  
122 -[[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]]
123 123  
124 -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.
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 128  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.
129 129  
130 -=== 3.7 Topic consumer lag ===
120 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
131 131  
132 -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 ===
133 133  
134 -{{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}}
135 -
136 -Once filled in, the solution should look similar as follows.
137 -
138 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
139 -
140 -=== 3.8 Recipient(s) configuration ===
141 -
142 142  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.
143 143  
144 144  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
... ... @@ -145,7 +145,7 @@
145 145  
146 146  {{info}}Note that when you define multiple external recipients, you need to separate each email address with a comma to make it work.{{/info}}
147 147  
148 -=== 3.9 Congestion control configuration ===
130 +=== 3.7 Congestion control configuration ===
149 149  
150 150  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.
151 151  
... ... @@ -155,14 +155,12 @@
155 155  
156 156  == 4. Key takeaways ==
157 157  
158 -* There are seven trigger options
140 +* There are five trigger options
159 159  ** Error message
160 160  ** Log message
161 161  ** Queue consumers
162 162  ** Messages in queue
163 163  ** Queue throughput
164 -** Messages added to topic
165 -** Topic consumer messages behind
166 166  * On the trigger level, the recipients are defined
167 167  * On the trigger level, the congestion control is defined
168 168  * Default configuration of the congestion control is sufficient in most cases