Skip to Content

Wiki source code of Dynamic Alerting

Version 42.1 by Carlijn Kokkeler on 2024/08/14 12:11
Show last authors
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"]].
3
4 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5
6 == 1. Prerequisites ==
7
8 * Basic knowledge of the eMagiz platform
9
10 == 2. Key concepts ==
11
12 This microlearning centers on configuring dynamic alerting based on triggers you can define as a user.
13 By defining, we mean: Specifying based on what triggers an alert needs to be raised.
14
15 * There are four trigger options
16 ** Error message
17 ** Log message
18 ** Messages added to topic
19 ** Topic consumer messages behind
20 * On the trigger level, the recipients are defined
21
22 {{html}}
23 <!-- * On the trigger level, the congestion control is defined -->
24 {{/html}}
25
26 == 3. Dynamic Alerting ==
27
28 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.
29
30 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.
31
32 In this page, we offer dynamic alerting on four different types.
33
34 * Error message
35 * Log message
36 * Messages added to topic
37 * Topic consumer messages behind
38
39 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
40
41 {{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}}
42
43 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).
44
45 === 3.1 Error message ===
46
47 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.
48
49 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.
50
51 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-error-message-configuration.png]]
52
53 === 3.2 Log message ===
54
55 On top of the "static" alert that is autogenerated by eMagiz on Log messages, you can add additional "dynamic" alerts that only trigger when a log message contains a specific phrase. This is likely when you log something on which you want to alert when it happens.
56
57 To define the trigger, fill in the phrase you want to check. 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
59 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
60
61 === 3.3 Messages added to topic ===
62
63 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.
64
65 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-all-topics.png]]
66
67 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.
68
69 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-topic-selection.png]]
70
71 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.
72
73 === 3.4 Topic consumer lag ===
74
75 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.
76
77 {{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}}
78
79 Once filled in, the solution should look similar as follows.
80
81 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
82
83 === 3.5 Recipient(s) configuration ===
84
85 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.
86
87 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
88
89 {{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}}
90
91 {{html}}
92 <!--
93 === 3.3 Queue consumers ===
94
95 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.
96
97 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.
98
99 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-all-queues.png]]
100
101 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.
102
103 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-specific-queues.png]]
104
105 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.
106
107 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
108
109 {{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}}
110
111 Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
112
113 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection-result.png]]
114
115 === 3.4 Messages in queue ===
116
117 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.
118
119 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-all-queues.png]]
120
121 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.
122
123 {{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}}
124
125 Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
126
127 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]]
128
129 === 3.5 Queue througput ===
130
131 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.
132
133 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
134
135 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.
136
137 {{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}}
138
139 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.
140
141 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
142
143 === 3.6 Congestion control configuration ===
144
145 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.
146
147 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]]
148
149 {{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}}
150
151 -->
152 {{/html}}
153
154 == 4. Key takeaways ==
155
156 * There are four trigger options that eMagiz provides for dynamic alerting:
157 ** Error message
158 ** Log message
159 ** Messages added to topic
160 ** Topic consumer messages behind
161 * On the trigger level, the recipients are defined.
162 * When entering multiple external recipients for these dynamic alerting triggers, ensure that you have listed them in the Manage->Alerting->Triggers->Notifications settings tab.
163
164 {{html}}
165 <!--
166 * On the trigger level, the congestion control is defined
167 * Default configuration of the congestion control is sufficient in most cases
168 -->
169 {{/html}}
170 == 5. Suggested Additional Readings ==
171
172 * [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
173 ** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
174 *** [[Standard Alerting eMagiz (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]]
175 * [[Setting up notifications>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3||target="blank"]]
176 )))((({{toc/}}))){{/container}}{{/container}}