Skip to Content

Changes for page Customize Queue Alerting

Last modified by Danniar Firdausy on 2024/09/04 15:45
From version 24.1
edited by Erik Bakker
on 2022/06/10 09:47
Change comment: Deleted image "novice-alerting-linking-tags-to-triggers--example-trigger-detail-select-tag.png"
To version 30.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 -Linking Tag(s) to Trigger(s)
1 +Dynamic Alerting
Parent
... ... @@ -1,1 +1,1 @@
1 -WebHome
1 +Main.eMagiz Academy.Microlearnings.Novice.Alerting.WebHome
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,12 +1,8 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will focus on how you can link your alerting tag(s) to alerting trigger(s).
3 -In a previous microlearning we already discussed parts of this. In this microlearning we will zoom in on the Trigger section of Alerting.
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"]].
4 4  
5 5  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
6 6  
7 -* Last update: April 1th 2021
8 -* Required reading time: 5 minutes
9 -
10 10  == 1. Prerequisites ==
11 11  
12 12  * Basic knowledge of the eMagiz platform
... ... @@ -13,65 +13,147 @@
13 13  
14 14  == 2. Key concepts ==
15 15  
16 -This microlearning centers around linking tag(s) to trigger(s).
17 -With linking, we mean: Categorize a certain trigger with the help of tag functionality
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
18 18  
19 -* Make tags descriptive in nature
20 -* Re-use tags over multiple triggers that have the same aim
21 -* In case of a start, daily and end alert use the same tag for all of them
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  
24 +== 3. Dynamic Alerting ==
23 23  
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.
24 24  
25 -== 3. Linking Tag(s) to Trigger(s) ==
28 +We offer alerting on five types.
26 26  
27 -In our previous dalliance with this subject we already discussed parts of what we will discuss in this microlearning. This microlearning is mainly meant to reiterate the importance of using proper tags when setting up your alerting. Linking the correct tag(s) to your trigger(s) will help you to clarify how the alerting structure for your project is set up. This is not only nice when you want to revisit the alerting section but it is also very usefull in communication with the business and with a support desk. This way you can create a common truth surrounding a common language. Key parts in achieving this are:
30 +* Error message
31 +* Log message
32 +* Queue consumers
33 +* Messages in queue
34 +* Queue throughput
28 28  
29 -* Make tags descriptive in nature
30 -* Re-use tags over multiple triggers that have the same aim
31 -* In case of a start, daily and end alert use the same tag for all of them
36 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
32 32  
33 -To link tag(s) to trigger(s) you navigate to Manage -> Alerting -> Triggers
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).
34 34  
35 -In this overview you can simply select a specific trigger to see the detailed configuration of the trigger. Depending on the type of trigger that you open the avaiable tabs within the pop-up and the information shown in the pop-up can differ. Below we show two distinct examples:
40 +=== 3.1 Error message ===
36 36  
37 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-data-measurements.png]]
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.
38 38  
39 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-log-entry.png]]
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.
40 40  
41 -As you can see from these examples is that the number of tabs within the pop-up differ. The first tab is were the configuration of the trigger happens. In all the other tabs you need to link the tag(s) to the trigger. To do so simply press Add in one of these tabs, search for the Tag you want to link to this trigger, select it and press Select.
46 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-error-message-configuration.png]]
42 42  
43 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-no-tag.png]]
48 +=== 3.2 Log message ===
44 44  
45 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-select-tag.png]]
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.
46 46  
47 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-one-tag.png]]
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.
48 48  
49 -When you are happy with your selection you can press Save on trigger level and eMagiz will link the tag to the trigger.
54 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
50 50  
56 +=== 3.3 Queue consumers ===
51 51  
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.
52 52  
53 -== 4. Assignment ==
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.
54 54  
55 -Link an (extra) tag to a trigger.
56 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
62 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-all-queues.png]]
57 57  
58 -== 5. Key takeaways ==
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.
59 59  
60 -* Assist in creating a common language
61 -* Make tags descriptive in nature
62 -* Re-use tags over multiple triggers that have the same aim
63 -* In case of a start, daily and end alert use the same tag for all of them
66 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-specific-queues.png]]
64 64  
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.
65 65  
70 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
66 66  
67 -== 6. Suggested Additional Readings ==
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}}
68 68  
69 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
74 +Once you have selected the queue(s) and pressed "Select" eMagiz will close the pop-up and add the queues to the trigger.
70 70  
71 -== 7. Silent demonstration video ==
76 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection-result.png]]
72 72  
73 -This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
78 +=== 3.4 Messages in queue ===
74 74  
75 -{{video attachment="novice-alerting-linking-tags-to-triggers.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
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.
76 76  
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 +
138 +== 4. Key takeaways ==
139 +
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
150 +
151 +== 5. Suggested Additional Readings ==
152 +
153 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
154 +
77 77  )))((({{toc/}}))){{/container}}{{/container}}