Skip to Content

Changes for page Customize Queue Alerting

Last modified by Danniar Firdausy on 2024/09/04 15:45
From version 40.8
edited by Danniar Firdausy
on 2024/07/18 14:46
Change comment: There is no comment for this version
To version 40.3
edited by Danniar Firdausy
on 2024/07/18 13:27
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,6 +1,8 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will focus on how you can customize your queue alerts by configuring the trigger conditions and thresholds, which raise an alert and notify people when those points are passed. 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"]]. Note that the queue alerting explained in this page is only applicable for eMagiz models that are running the current generation runtime architecture.
2 +In this microlearning, we will focus on how you can customize your queue alerts by configuring the trigger conditions and thresholds, which raise an alert and notify people when those points are passed.
3 3  
4 +. 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"]].
5 +
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 6  == 1. Prerequisites ==
... ... @@ -9,31 +9,154 @@
9 9  
10 10  == 2. Key concepts ==
11 11  
12 -This microlearning focuses on customizing the queue alerts for each environment in your model. By customizing: we mean further configuring the trigger conditions and thresholds of your queues from the general default settings provided by eMagiz, so they better suit your needs and requirements.
14 +This microlearning centers configuring dynamic alerting based on triggers you can define as a user.
15 +By defining, we mean: Specifying based on what triggers an alert needs to be raised.
13 13  
14 -* eMagiz applies the same set of triggers to all JMS queues
15 -* There are four queue trigger options that eMagiz currently provides:
16 -** Consumers check
17 -** Queue load check
18 -** Inactivity check
19 -** Periodic activity check
20 -* Recipients are defined on the queue level.
17 +* There are five trigger options
18 +** Error message
19 +** Log message
20 +** Queue consumers
21 +** Messages in queue
22 +** Queue throughput
23 +* On the trigger level, the recipients are defined
24 +* On the trigger level, the congestion control is defined
21 21  
22 -== 3. Queue Alerting ==
26 +== 3. Dynamic Alerting ==
23 23  
24 -In principle, queue alerting refers to the configuration of alerts that work by applying a uniform set of triggers to all queues in your model. By queues here, we mean all queues that are generated by eMagiz and present in the Create phase of your model. This means that all of these queues by default have triggers configured for them. eMagiz
28 +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.
25 25  
26 -However, as a user, you can also further customize the trigger condition and thresholds for each of these queues.
30 +We offer alerting on seven types.
27 27  
28 -== 3.1 Customize Queue Alerting ==
32 +* Error message
33 +* Log message
34 +* Queue consumers
35 +* Messages in queue
36 +* Queue throughput
37 +* Messages added to topic
38 +* Topic consumer messages behind
29 29  
40 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
30 30  
42 +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).
31 31  
44 +=== 3.1 Error message ===
45 +
46 +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.
47 +
48 +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.
49 +
50 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-error-message-configuration.png]]
51 +
52 +=== 3.2 Log message ===
53 +
54 +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.
55 +
56 +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.
57 +
58 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
59 +
60 +=== 3.3 Queue consumers ===
61 +
62 +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.
63 +
64 +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.
65 +
66 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-all-queues.png]]
67 +
68 +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.
69 +
70 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-specific-queues.png]]
71 +
72 +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.
73 +
74 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
75 +
76 +{{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}}
77 +
78 +Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
79 +
80 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection-result.png]]
81 +
82 +=== 3.4 Messages in queue ===
83 +
84 +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.
85 +
86 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-all-queues.png]]
87 +
88 +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.
89 +
90 +{{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}}
91 +
92 +Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
93 +
94 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]]
95 +
96 +=== 3.5 Queue througput ===
97 +
98 +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.
99 +
100 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
101 +
102 +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.
103 +
104 +{{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}}
105 +
106 +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.
107 +
108 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
109 +
110 +=== 3.6 Messages added to topic ===
111 +
112 +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.
113 +
114 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-all-topics.png]]
115 +
116 +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.
117 +
118 +{{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}}
119 +
120 +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.
121 +
122 +=== 3.7 Topic consumer lag ===
123 +
124 +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.
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 +Once filled in, the solution should look similar as follows.
129 +
130 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
131 +
132 +=== 3.8 Recipient(s) configuration ===
133 +
134 +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.
135 +
136 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
137 +
138 +{{info}}Note that when you define multiple external recipients, you need to separate each email address with a comma to make it work.{{/info}}
139 +
140 +=== 3.9 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 +
32 32  == 4. Key takeaways ==
33 33  
34 -* a
35 -* b
36 -* c
150 +* There are seven trigger options
151 +** Error message
152 +** Log message
153 +** Queue consumers
154 +** Messages in queue
155 +** Queue throughput
156 +** Messages added to topic
157 +** Topic consumer messages behind
158 +* On the trigger level, the recipients are defined
159 +* On the trigger level, the congestion control is defined
160 +* Default configuration of the congestion control is sufficient in most cases
161 +* When entering multiple external recipients, ensure each email address is separated with a comma
37 37  
38 38  == 5. Suggested Additional Readings ==
39 39