Wiki source code of Customize Queue Alerting

Version 40.6 by Danniar Firdausy on 2024/07/18 13:41

version	line-number	content
17.1	1	{{container}}{{container layoutStyle="columns"}}(((
40.4	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"]].
1.1	3
17.1	4	Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
1.1	5
	6	== 1. Prerequisites ==
	7
	8	* Basic knowledge of the eMagiz platform
	9
	10	== 2. Key concepts ==
	11
40.6	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.
1.1	13
30.1	14	* There are five trigger options
	15	** Error message
	16	** Log message
	17	** Queue consumers
	18	** Messages in queue
	19	** Queue throughput
32.1	20	* On the trigger level, the recipients are defined
	21	* On the trigger level, the congestion control is defined
1.1	22
30.1	23	== 3. Dynamic Alerting ==
1.1	24
32.1	25	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.
1.1	26
35.1	27	We offer alerting on seven types.
1.1	28
30.1	29	* Error message
	30	* Log message
	31	* Queue consumers
	32	* Messages in queue
	33	* Queue throughput
35.1	34	* Messages added to topic
	35	* Topic consumer messages behind
1.1	36
30.1	37	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
1.1	38
32.1	39	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).
1.1	40
30.1	41	=== 3.1 Error message ===
1.1	42
32.1	43	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.
1.1	44
32.1	45	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.
1.1	46
30.1	47	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-error-message-configuration.png]]
1.1	48
30.1	49	=== 3.2 Log message ===
1.1	50
32.1	51	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.
1.1	52
32.1	53	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.
1.1	54
30.1	55	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
1.1	56
30.1	57	=== 3.3 Queue consumers ===
1.1	58
32.1	59	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.
1.1	60
32.1	61	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.
1.1	62
30.1	63	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-all-queues.png]]
1.1	64
32.1	65	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.
1.1	66
30.1	67	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-specific-queues.png]]
1.1	68
32.1	69	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.
1.1	70
30.1	71	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
	72
32.1	73	{{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}}
30.1	74
32.1	75	Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
30.1	76
	77	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection-result.png]]
	78
	79	=== 3.4 Messages in queue ===
	80
32.1	81	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.
30.1	82
	83	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-all-queues.png]]
	84
32.1	85	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.
30.1	86
38.1	87	{{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}}
30.1	88
32.1	89	Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
30.1	90
	91	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]]
	92
	93	=== 3.5 Queue througput ===
	94
35.1	95	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.
30.1	96
	97	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
	98
32.1	99	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.
30.1	100
38.1	101	{{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}}
30.1	102
32.1	103	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.
30.1	104
	105	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
	106
35.1	107	=== 3.6 Messages added to topic ===
30.1	108
35.1	109	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.
	110
	111	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-all-topics.png]]
	112
	113	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.
	114
38.1	115	{{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}}
35.1	116
	117	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.
	118
	119	=== 3.7 Topic consumer lag ===
	120
	121	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.
	122
37.1	123	{{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}}
35.1	124
	125	Once filled in, the solution should look similar as follows.
	126
	127	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
	128
	129	=== 3.8 Recipient(s) configuration ===
	130
32.1	131	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.
30.1	132
	133	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
	134
32.1	135	{{info}}Note that when you define multiple external recipients, you need to separate each email address with a comma to make it work.{{/info}}
30.1	136
35.1	137	=== 3.9 Congestion control configuration ===
30.1	138
32.1	139	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.
30.1	140
	141	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]]
	142
32.1	143	{{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}}
30.1	144
	145	== 4. Key takeaways ==
	146
35.1	147	* There are seven trigger options
30.1	148	** Error message
	149	** Log message
	150	** Queue consumers
	151	** Messages in queue
	152	** Queue throughput
35.1	153	** Messages added to topic
	154	** Topic consumer messages behind
32.1	155	* On the trigger level, the recipients are defined
	156	* On the trigger level, the congestion control is defined
30.1	157	* Default configuration of the congestion control is sufficient in most cases
32.1	158	* When entering multiple external recipients, ensure each email address is separated with a comma
30.1	159
	160	== 5. Suggested Additional Readings ==
	161
32.1	162	If you are interested in this topic and want more information, please read the help text provided by eMagiz.
30.1	163
17.1	164	)))((({{toc/}}))){{/container}}{{/container}}

Wiki source code of Customize Queue Alerting

Navigation