Skip to Content

Changes for page Customize Queue Alerting

Last modified by Danniar Firdausy on 2024/09/04 15:45
From version 43.6
edited by Danniar Firdausy
on 2024/07/22 13:12
Change comment: There is no comment for this version
To version 31.1
edited by Erik Bakker
on 2023/02/06 08:55
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Customize Queue Alerting
1 +Dynamic Alerting
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dfirdausy
1 +XWiki.ebakker
Content
... ... @@ -1,5 +1,5 @@
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 configure your own dynamic alerting by setting up triggers on events and notifiying people on it. Should you want to learn more on 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  
... ... @@ -6,42 +6,150 @@
6 6  == 1. Prerequisites ==
7 7  
8 8  * Basic knowledge of the eMagiz platform
9 -* Basic knowledge of alerting in the eMagiz platform
10 10  
11 11  == 2. Key concepts ==
12 12  
13 -This microlearning focuses on customizing the queue alerts for each environment (i.e., Testing-Acceptance-Production) 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.
12 +This microlearning centers configuring dynamic alerting based on triggers you can define as a user.
13 +With defining, we mean: Specifying based on what trigger an alert needs to be raised
14 14  
15 -* eMagiz applies the same set of triggers to all JMS queues
16 -* There are four queue trigger options that eMagiz currently provides:
17 -** Consumers check
18 -** Queue load check
19 -** Inactivity check
20 -** Periodic activity check
21 -* Recipients are defined on the queue level.
15 +* There are five trigger options
16 +** Error message
17 +** Log message
18 +** Queue consumers
19 +** Messages in queue
20 +** Queue throughput
21 +* On trigger level the recipients are defined
22 +* On trigger level the congestion control is defined
22 22  
23 -== 3. Queue Alerting ==
24 -=== 3.1 Queue Alerting Overview ===
25 -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 existing in the Create phase of your model. Out-of-the-box, eMagiz provides the default values that are suitable for the topology of each of your model environments (Testing-Acceptance-Production). By topology here, we refer whether your environment is running on single-lane or double-lane setup. In the screenshot below, you can find the overview of your queue alerts by navigating to Manage -> Alerting -> Triggers.
24 +== 3. Dynamic Alerting ==
26 26  
27 -[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-manage-alerting-in-emagiz-queue-alerts-overview.png]]
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 on 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 teammembers (with sufficient rights) can view, edit and delete.
28 28  
29 -Here, you will find all the queues that are generated by eMagiz and currently existing in the Create phase of your model, along with the trigger conditions and thresholds that are applied to each of these queues. Next to that, you can also find edit buttons (green paper and pencil buttons) at the end of each queue trigger as well as the "Configure defaults" (or "View defaults" depending if your account does not have the edit rights on Manage) button above the list of these queue triggers. In the following sections, we will discuss how you can customize these queue triggers as well as customize the default values to suit your needs.
28 +We offer alerting on five types.
30 30  
31 -=== 3.2 Customize Queue Alerting ===
30 +* Error message
31 +* Log message
32 +* Queue consumers
33 +* Messages in queue
34 +* Queue throughput
32 32  
33 -As a user, you can customize these default values to better suit your model's requirements, as well as modify the trigger conditions and thresholds for each queue. To customize the default values that eMagiz has configured by default, you can click the "Configure defaults" button on top of this list. You will see
36 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
34 34  
35 -=== 3.3 Customize Default Values ===
38 +At first we will discuss the configuration of each trigger type. Subsequently we will discuss how to define which recipients will be notified and how to alter the default congestion control settings (as this is the same for each trigger type).
36 36  
40 +=== 3.1 Error message ===
41 +
42 +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 specific value. This is most likely relevant when certain error message with certain characteristics (i.e. a certain header value) need to be sent to a different set of recipients.
43 +
44 +To define the trigger simply fill in the name of the header and the expected value. On top of that you can fill in a description that will be added to the alert that is received via eMail. Once this is filled in the configuration could look as follows.
45 +
46 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-error-message-configuration.png]]
47 +
48 +=== 3.2 Log message ===
49 +
50 +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 most likely when you log something on which you want to alert when it happens.
51 +
52 +To define the trigger simply fill in the phrase on which you want to check. On top of that you can fill in a description that will be added to the alert that is received via eMail. Once this is filled in the configuration could look as follows.
53 +
54 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
55 +
56 +=== 3.3 Queue consumers ===
57 +
58 +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.
59 +
60 +To define the trigger first define the threshold on which you want to check (i.e. 2). Subsequently define whether on which queues (or all queues) you want eMagiz to check for this condition. If you want to check on all queues no further action is needed.
61 +
62 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-all-queues.png]]
63 +
64 +If you want to check on a specific (set of) queue(s) you can uncheck the checkbox. As a result an "Add" and a "Remove" button are displayed by eMagiz through which you can add and remove queues to the trigger.
65 +
66 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-specific-queues.png]]
67 +
68 +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 select one (or more) queues and press the "Select" button to add them to the trigger.
69 +
70 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
71 +
72 +{{info}}Note, that when you want to select multiple queues at once you cannot press "Enter" to Save your selection. In this case you really need to press the "Select" button to save your selection.{{/info}}
73 +
74 +Once you have selected the queue(s) and pressed "Select" eMagiz will close the pop-up and add the queues to the trigger.
75 +
76 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection-result.png]]
77 +
78 +=== 3.4 Messages in queue ===
79 +
80 +On top of the "static" alert that is autogenerated by eMagiz on Messages in queue you can add additional "dynamic" alerts that only trigger when a queue holds more than X number of 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. If you want to check on all queues no further action is needed.
81 +
82 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-all-queues.png]]
83 +
84 +If you want to check on a specific (set of) queue(s) you can uncheck the checkbox. As a result an "Add" and a "Remove" button are displayed by eMagiz through which you can add and remove queues to the trigger.
85 +
86 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-specific-queues.png]]
87 +
88 +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 select one (or more) queues and press the "Select" button to add them to the trigger.
89 +
90 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
91 +
92 +{{info}}Note, that when you want to select multiple queues at once you cannot press "Enter" to Save your selection. In this case you really need to press the "Select" button to save your selection.{{/info}}
93 +
94 +Once you have selected the queue(s) and pressed "Select" eMagiz will close the pop-up and add the queues to the trigger.
95 +
96 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]]
97 +
98 +=== 3.5 Queue througput ===
99 +
100 +On top of the "static" alert that is autogenerated by eMagiz on Error messages you can add additional "dynamic" alerts that only trigger when the througput 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. If you want to check on all queues no further action is needed.
101 +
102 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
103 +
104 +If you want to check on a specific (set of) queue(s) you can uncheck the checkbox. As a result an "Add" and a "Remove" button are displayed by eMagiz through which you can add and remove queues to the trigger.
105 +
106 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-specific-queues.png]]
107 +
108 +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 select one (or more) queues and press the "Select" button to add them to the trigger.
109 +
110 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
111 +
112 +{{info}}Note, that when you want to select multiple queues at once you cannot press "Enter" to Save your selection. In this case you really need to press the "Select" button to save your selection.{{/info}}
113 +
114 +Once you have selected the queue(s) and pressed "Select" eMagiz will close the pop-up and add the queues to the trigger.
115 +
116 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-queue-selection-result.png]]
117 +
118 +For this trigger an additional criteria can be configured that allows 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 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
121 +
122 +=== 3.6 Recipient(s) configuration ===
123 +
124 +When you switch from the "Trigger" to the "Output" tab you can select your recipients. In this overview you can select both eMagiz users as well as external recipients.
125 +
126 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
127 +
128 +{{info}}Note that when you define multiple external recipients you need to seperate each emailadress with a comma to make it work.{{/info}}
129 +
130 +=== 3.7 Congestion control configuration ===
131 +
132 +In the same "Output" tab you can also define the congestion control configuration. The default configuration is that congestion control is activated and will be activated once more than ten alerts are triggered in the last ten minutes. Should you want to reduce this number you can do so here.
133 +
134 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]]
135 +
136 +{{warning}}Note, that we advise to only reduce the number under the congestion control if the default of ten is too high. We do **not** advise to deactivate the congestion control as this can cause an explosion in the number of received notifications.{{/warning}}
137 +
37 37  == 4. Key takeaways ==
38 38  
39 -* a
40 -* b
41 -* c
140 +* There are five trigger options
141 +** Error message
142 +** Log message
143 +** Queue consumers
144 +** Messages in queue
145 +** Queue throughput
146 +* On trigger level the recipients are defined
147 +* On trigger level the congestion control is defined
148 +* Default configuration of the congestion control is sufficient in most cases
149 +* When entering multiple external recipients ensure each email address is seperated with a comma
42 42  
43 43  == 5. Suggested Additional Readings ==
44 44  
45 -If you are interested in this topic and want more information, please read the help text provided by eMagiz.
153 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
46 46  
47 47  )))((({{toc/}}))){{/container}}{{/container}}