Skip to Content

Changes for page Dynamic Alerting

Last modified by Danniar Firdausy on 2024/11/19 11:08
From version 39.1
edited by Erik Bakker
on 2023/05/27 14:00
Change comment: There is no comment for this version
To version 39.21
edited by Danniar Firdausy
on 2024/07/29 15:20
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.dfirdausy
Content
... ... @@ -9,9 +9,11 @@
9 9  
10 10  == 2. Key concepts ==
11 11  
12 -This microlearning centers configuring dynamic alerting based on triggers you can define as a user.
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 +<!--
15 15  * There are five trigger options
16 16  ** Error message
17 17  ** Log message
... ... @@ -18,25 +18,33 @@
18 18  ** Queue consumers
19 19  ** Messages in queue
20 20  ** 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
21 21  * On the trigger level, the recipients are defined
22 22  * On the trigger level, the congestion control is defined
23 23  
24 24  == 3. Dynamic Alerting ==
25 25  
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.
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.
27 27  
28 -We offer alerting on seven types.
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.
29 29  
39 +In this page, we offer alerting on four types.
40 +
30 30  * Error message
31 31  * Log message
32 -* Queue consumers
33 -* Messages in queue
34 -* Queue throughput
35 35  * Messages added to topic
36 36  * Topic consumer messages behind
37 37  
38 38  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
39 39  
48 +{{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 the "Queues" tab. Please refer to the [[Customize Queue alerting>>doc:Main.eMagiz Academy.Microlearnings.Novice.Alerting.novice-alerting-customize-queue-alerting.WebHome||target="blank"]] microlearning to learn more on how to customize the triggers or the default values for these queues.{{/info}}
49 +
40 40  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).
41 41  
42 42  === 3.1 Error message ===
... ... @@ -55,6 +55,46 @@
55 55  
56 56  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
57 57  
68 +=== 3.3 Messages added to topic ===
69 +
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.
71 +
72 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-all-topics.png]]
73 +
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.
75 +
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}}
77 +
78 +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.
79 +
80 +=== 3.4 Topic consumer lag ===
81 +
82 +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.
83 +
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}}
85 +
86 +Once filled in, the solution should look similar as follows.
87 +
88 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
89 +
90 +=== 3.8 Recipient(s) configuration ===
91 +
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.
93 +
94 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
95 +
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}}
97 +
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 +
106 +{{html}}
107 +<!--
58 58  === 3.3 Queue consumers ===
59 59  
60 60  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.
... ... @@ -104,45 +104,9 @@
104 104  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.
105 105  
106 106  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
157 +-->
158 +{{/html}}
107 107  
108 -=== 3.6 Messages added to topic ===
109 -
110 -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.
111 -
112 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-all-topics.png]]
113 -
114 -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.
115 -
116 -{{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}}
117 -
118 -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.
119 -
120 -=== 3.7 Topic consumer lag ===
121 -
122 -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.
123 -
124 -{{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}}
125 -
126 -Once filled in, the solution should look similar as follows.
127 -
128 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
129 -
130 -=== 3.8 Recipient(s) configuration ===
131 -
132 -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.
133 -
134 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
135 -
136 -{{info}}Note that when you define multiple external recipients, you need to separate each email address with a comma to make it work.{{/info}}
137 -
138 -=== 3.9 Congestion control configuration ===
139 -
140 -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.
141 -
142 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]]
143 -
144 -{{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}}
145 -
146 146  == 4. Key takeaways ==
147 147  
148 148  * There are seven trigger options