Changes for page Customize Queue Alerting

Summary

• Page properties (1 modified, 0 added, 0 removed)

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 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"]].
	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	3
4	4	Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5	5
...	...	@@ -10,7 +10,7 @@
10	10	== 2. Key concepts ==
11	11
12	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
	13	+By defining, we mean: Specifying based on what triggers an alert needs to be raised.
14	14
15	15	* There are five trigger options
16	16	** Error message
...	...	@@ -18,12 +18,12 @@
18	18	** Queue consumers
19	19	** Messages in queue
20	20	** Queue throughput
21		-* On trigger level the recipients are defined
22		-* On trigger level the congestion control is defined
	21	+* On the trigger level, the recipients are defined
	22	+* On the trigger level, the congestion control is defined
23	23
24	24	== 3. Dynamic Alerting ==
25	25
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.
	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 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.
27	27
28	28	We offer alerting on five types.
29	29
...	...	@@ -35,105 +35,105 @@
35	35
36	36	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
37	37
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).
	38	+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).
39	39
40	40	=== 3.1 Error message ===
41	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.
	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 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.
43	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.
	44	+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.
45	45
46	46	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-error-message-configuration.png]]
47	47
48	48	=== 3.2 Log message ===
49	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.
	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 likely when you log something on which you want to alert when it happens.
51	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.
	52	+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.
53	53
54	54	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
55	55
56	56	=== 3.3 Queue consumers ===
57	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.
	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	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.
	60	+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.
61	61
62	62	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-all-queues.png]]
63	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.
	64	+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.
65	65
66	66	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-specific-queues.png]]
67	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.
	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 choose one (or more) queues and press the "Select" button to add them to the trigger.
69	69
70	70	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
71	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}}
	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 need to press the "Select" button to save your choice.{{/info}}
73	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.
	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	75
76	76	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection-result.png]]
77	77
78	78	=== 3.4 Messages in queue ===
79	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.
	80	+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.
81	81
82	82	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-all-queues.png]]
83	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.
	84	+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.
85	85
86	86	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-specific-queues.png]]
87	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.
	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 choose one (or more) queues and press the "Select" button to add them to the trigger.
89	89
90	90	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
91	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}}
	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 need to press the "Select" button to save your choice.{{/info}}
93	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.
	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	95
96	96	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]]
97	97
98	98	=== 3.5 Queue througput ===
99	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.
	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 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.
101	101
102	102	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
103	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.
	104	+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.
105	105
106	106	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-specific-queues.png]]
107	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.
	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 choose one (or more) queues and press the "Select" button to add them to the trigger.
109	109
110	110	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
111	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}}
	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 need to press the "Select" button to save your choice.{{/info}}
113	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.
	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	115
116	116	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-queue-selection-result.png]]
117	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.
	118	+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.
119	119
120	120	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
121	121
122	122	=== 3.6 Recipient(s) configuration ===
123	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.
	124	+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.
125	125
126	126	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
127	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}}
	128	+{{info}}Note that when you define multiple external recipients, you need to separate each email address with a comma to make it work.{{/info}}
129	129
130	130	=== 3.7 Congestion control configuration ===
131	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.
	132	+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.
133	133
134	134	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]]
135	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}}
	136	+{{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}}
137	137
138	138	== 4. Key takeaways ==
139	139
...	...	@@ -143,13 +143,13 @@
143	143	** Queue consumers
144	144	** Messages in queue
145	145	** Queue throughput
146		-* On trigger level the recipients are defined
147		-* On trigger level the congestion control is defined
	146	+* On the trigger level, the recipients are defined
	147	+* On the trigger level, the congestion control is defined
148	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
	149	+* When entering multiple external recipients, ensure each email address is separated with a comma
150	150
151	151	== 5. Suggested Additional Readings ==
152	152
153		-If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
	153	+If you are interested in this topic and want more information, please read the help text provided by eMagiz.
154	154
155	155	)))((({{toc/}}))){{/container}}{{/container}}