Skip to Content

Changes for page Dynamic Alerting

Last modified by Danniar Firdausy on 2024/11/19 11:08
From version 39.12
edited by Danniar Firdausy
on 2024/07/29 14:15
Change comment: There is no comment for this version
To version 49.5
edited by Danniar Firdausy
on 2024/11/19 11:02
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will focus on how you can configure your dynamic alerting by setting up triggers on events and notifying people about them. Should you want to learn more about the standard alerting that eMagiz offers, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]].
2 +In this microlearning, we'll dive into configuring dynamic alerting in eMagiz. Dynamic alerts allow you to set up notifications based on specific triggers you define, helping you stay on top of critical events in your integration landscape. You can create alerts for error messages, log messages, topic updates, and consumer lag, and customize who gets notified. We’ll walk you through the different types of triggers and how to set them up effectively. Should you want to learn more about the standard alerting that eMagiz offers, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]].
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -12,44 +12,32 @@
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
15 +* There are three trigger options
19 19  ** Log message
20 -** Queue consumers
21 -** Messages in queue
22 -** Queue throughput
23 --->
24 -{{/html}}
25 -* There are four trigger options
26 -** Error message
27 -** Log message
28 28  ** Messages added to topic
29 29  ** Topic consumer messages behind
30 30  * On the trigger level, the recipients are defined
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.
23 +To enhance the observability of your integration landscape while running in the current generation 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.
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.
25 +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.
38 38  
39 -We offer alerting on seven types.
27 +In this page, we offer dynamic alerting on three different types.
40 40  
41 -* Error message
42 42  * Log message
43 -* Queue consumers
44 -* Messages in queue
45 -* Queue throughput
46 46  * Messages added to topic
47 47  * Topic consumer messages behind
48 48  
49 49  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
50 50  
35 +{{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}}
36 +
51 51  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).
52 52  
39 +{{html}}
40 +<!--
53 53  === 3.1 Error message ===
54 54  
55 55  On top of the "static" alert that is autogenerated by eMagiz on Error messages, you can add additional "dynamic" alerts that only trigger when an error message is raised for which a specific header contains a particular value. This is most likely relevant when a specific error message with certain characteristics (i.e., a particular header value) needs to be sent to a different set of recipients.
... ... @@ -57,6 +57,8 @@
57 57  To define the trigger, fill in the header's name and the expected value. On top of that, you can fill in a description that will be added to the alert received via email. Once this is filled in, the configuration could look as follows.
58 58  
59 59  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-error-message-configuration.png]]
48 +-->
49 +{{/html}}
60 60  
61 61  === 3.2 Log message ===
62 62  
... ... @@ -66,111 +66,55 @@
66 66  
67 67  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
68 68  
69 -=== 3.3 Queue consumers ===
59 +=== 3.3 Messages added to topic ===
70 70  
71 -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.
61 +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.
72 72  
73 -To define the trigger, determine the threshold you want to check (i.e., 2). Subsequently, specify 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.
74 -
75 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-all-queues.png]]
76 -
77 -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.
78 -
79 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-specific-queues.png]]
80 -
81 -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.
82 -
83 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
84 -
85 -{{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}}
86 -
87 -Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
88 -
89 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection-result.png]]
90 -
91 -=== 3.4 Messages in queue ===
92 -
93 -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.
94 -
95 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-all-queues.png]]
96 -
97 -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.
98 -
99 -{{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}}
100 -
101 -Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
102 -
103 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]]
104 -
105 -=== 3.5 Queue througput ===
106 -
107 -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.
108 -
109 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
110 -
111 -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.
112 -
113 -{{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}}
114 -
115 -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.
116 -
117 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
118 -
119 -=== 3.6 Messages added to topic ===
120 -
121 -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.
122 -
123 123  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-all-topics.png]]
124 124  
125 -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 +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.
126 126  
127 -{{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 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-topic-selection.png]]
128 128  
129 129  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.
130 130  
131 -=== 3.7 Topic consumer lag ===
71 +=== 3.4 Topic consumer lag ===
132 132  
133 133  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.
134 134  
135 -{{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 +{{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}}
136 136  
137 137  Once filled in, the solution should look similar as follows.
138 138  
139 139  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
140 140  
141 -=== 3.8 Recipient(s) configuration ===
81 +=== 3.5 Recipient(s) configuration ===
142 142  
143 -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 +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 that is part of your company or has access to the model in question) and external recipients.
144 144  
145 145  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
146 146  
147 -{{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 +{{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}}
148 148  
149 -=== 3.9 Congestion control configuration ===
150 -
151 -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.
152 -
153 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]]
154 -
155 -{{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}}
156 -
157 157  == 4. Key takeaways ==
158 158  
159 -* There are seven trigger options
160 -** Error message
91 +* There are three trigger options that eMagiz provides for dynamic alerting:
161 161  ** Log message
162 -** Queue consumers
163 -** Messages in queue
164 -** Queue throughput
165 165  ** Messages added to topic
166 166  ** Topic consumer messages behind
167 -* On the trigger level, the recipients are defined
168 -* On the trigger level, the congestion control is defined
169 -* Default configuration of the congestion control is sufficient in most cases
170 -* When entering multiple external recipients, ensure each email address is separated with a comma
95 +* On the trigger level, the recipients are defined.
96 +* When entering multiple external recipients for these dynamic alerting triggers, ensure that you have listed them in the Manage->Alerting->Triggers->Notifications settings tab.
171 171  
172 172  == 5. Suggested Additional Readings ==
173 173  
174 -If you are interested in this topic and want more information, please read the help text provided by eMagiz.
100 +* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
101 +** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
102 +*** [[Standard Alerting eMagiz (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]]
103 +* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
104 +** [[Alerting (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Alerting.WebHome||target="blank"]]
105 +* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
106 +** [[Alerting (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.WebHome||target="blank"]]
107 +*** [[Setting up notifications (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3||target="blank"]]
108 +* [[Dynamic Alerting (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22dynamic+alerting%22||target="blank"]]
175 175  
176 176  )))((({{toc/}}))){{/container}}{{/container}}