Changes for page Dynamic Alerting

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

From version 39.38
edited by Danniar Firdausy
on 2024/07/29 16:04
Change comment: There is no comment for this version
To version 39.22
edited by Danniar Firdausy
on 2024/07/29 15:21
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -12,6 +12,16 @@
12 12  This microlearning centers on 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 +* There are five trigger options
18 +** Error message
19 +** Log message
20 +** Queue consumers
21 +** Messages in queue
22 +** Queue throughput
23 +-->
24 +{{/html}}
15 15  * There are four trigger options
16 16  ** Error message
17 17  ** Log message
... ... @@ -26,7 +26,7 @@
26 26  
27 27  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 28  
29 -In this page, we offer dynamic alerting on four different types.
39 +In this page, we offer alerting on four types.
30 30  
31 31  * Error message
32 32  * Log message
... ... @@ -57,13 +57,13 @@
57 57  
58 58  === 3.3 Messages added to topic ===
59 59  
60 -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. 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.
70 +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.
61 61  
62 62  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-all-topics.png]]
63 63  
64 -When you press the "Add" button, a new pop-up will appear through which you can select the topics for which you want the trigger to be activated. In this pop-up, you can choose one (or more) topics and press the "Select" button to add them to the trigger. Once you have selected the topic(s) and pressed "Select," eMagiz will close the pop-up and add the topics to the trigger.
74 +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.
65 65  
66 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-topic-selection.png]]
76 +{{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}}
67 67  
68 68  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.
69 69  
... ... @@ -71,22 +71,28 @@
71 71  
72 72  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.
73 73  
74 -{{info}}This process of adding and removing specific topics works identically as explained in the section on [[Messages added to topic.>>||anchor="H3.3Messagesaddedtotopic"]]{{/info}}
84 +{{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}}
75 75  
76 76  Once filled in, the solution should look similar as follows.
77 77  
78 78  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
79 79  
80 -=== 3.5 Recipient(s) configuration ===
90 +=== 3.8 Recipient(s) configuration ===
81 81  
82 -You can select your recipients when you switch from the "Trigger" to the "Output" tab. In this overview, you can choose both internal recipients (i.e., eMagiz users with access into this model) and external recipients.
92 +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.
83 83  
84 84  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
85 85  
86 -{{info}}Note that to add the external recipients to these four alertings discussed in this microlearning, you first need to list them via the Manage->Alerting->Triggers->Notifications settings tab. To do that, please refer to this [[page>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3||target="blank"]]{{/info}}
96 +{{info}}Note that when you define multiple external recipients, you need to separate each email address with a comma to make it work.{{/info}}
87 87  
88 -{{html}}
89 -<!--
98 +=== 3.9 Congestion control configuration ===
99 +
100 +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.
101 +
102 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]]
103 +
104 +{{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}}
105 +
90 90  === 3.3 Queue consumers ===
91 91  
92 92  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.
... ... @@ -109,6 +109,10 @@
109 109  
110 110  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection-result.png]]
111 111  
128 +{{html}}
129 +<!--
130 +
131 +
112 112  === 3.4 Messages in queue ===
113 113  
114 114  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.
... ... @@ -136,23 +136,17 @@
136 136  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.
137 137  
138 138  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
139 -
140 -=== 3.6 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 148  -->
149 149  {{/html}}
150 150  
151 151  == 4. Key takeaways ==
152 152  
153 -* There are four trigger options that eMagiz provides for dynamic alerting:
164 +* There are seven trigger options
154 154  ** Error message
155 155  ** Log message
167 +** Queue consumers
168 +** Messages in queue
169 +** Queue throughput
156 156  ** Messages added to topic
157 157  ** Topic consumer messages behind
158 158  * On the trigger level, the recipients are defined