Wiki source code of Dynamic Alerting

Version 33.1 by eMagiz on 2023/02/07 13:27

version	line-number	content
17.1	1	{{container}}{{container layoutStyle="columns"}}(((
32.1	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"]].
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
30.1	12	This microlearning centers configuring dynamic alerting based on triggers you can define as a user.
32.1	13	By defining, we mean: Specifying based on what triggers an alert needs to be raised.
1.1	14
30.1	15	* There are five trigger options
	16	** Error message
	17	** Log message
	18	** Queue consumers
	19	** Messages in queue
	20	** Queue throughput
32.1	21	* On the trigger level, the recipients are defined
	22	* On the trigger level, the congestion control is defined
1.1	23
30.1	24	== 3. Dynamic Alerting ==
1.1	25
32.1	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.
1.1	27
30.1	28	We offer alerting on five types.
1.1	29
30.1	30	* Error message
	31	* Log message
	32	* Queue consumers
	33	* Messages in queue
	34	* Queue throughput
1.1	35
30.1	36	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
1.1	37
32.1	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).
1.1	39
30.1	40	=== 3.1 Error message ===
1.1	41
32.1	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.
1.1	43
32.1	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.
1.1	45
30.1	46	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-error-message-configuration.png]]
1.1	47
30.1	48	=== 3.2 Log message ===
1.1	49
32.1	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.
1.1	51
32.1	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.
1.1	53
30.1	54	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
1.1	55
30.1	56	=== 3.3 Queue consumers ===
1.1	57
32.1	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.
1.1	59
32.1	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.
1.1	61
30.1	62	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-all-queues.png]]
1.1	63
32.1	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.
1.1	65
30.1	66	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-specific-queues.png]]
1.1	67
32.1	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.
1.1	69
30.1	70	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
	71
32.1	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}}
30.1	73
32.1	74	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	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
32.1	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.
30.1	81
	82	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-all-queues.png]]
	83
32.1	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.
30.1	85
	86	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-specific-queues.png]]
	87
32.1	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.
30.1	89
	90	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
	91
32.1	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}}
30.1	93
32.1	94	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	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
32.1	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.
30.1	101
	102	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
	103
32.1	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.
30.1	105
	106	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-specific-queues.png]]
	107
32.1	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.
30.1	109
	110	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
	111
32.1	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}}
30.1	113
32.1	114	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	115
	116	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-queue-selection-result.png]]
	117
32.1	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.
30.1	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
32.1	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.
30.1	125
	126	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
	127
32.1	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}}
30.1	129
	130	=== 3.7 Congestion control configuration ===
	131
32.1	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.
30.1	133
	134	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]]
	135
32.1	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}}
30.1	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
32.1	146	* On the trigger level, the recipients are defined
	147	* On the trigger level, the congestion control is defined
30.1	148	* Default configuration of the congestion control is sufficient in most cases
32.1	149	* When entering multiple external recipients, ensure each email address is separated with a comma
30.1	150
	151	== 5. Suggested Additional Readings ==
	152
32.1	153	If you are interested in this topic and want more information, please read the help text provided by eMagiz.
30.1	154
17.1	155	)))((({{toc/}}))){{/container}}{{/container}}

Wiki source code of Dynamic Alerting

Navigation