Wiki source code of Dynamic Alerting

Version 39.37 by Danniar Firdausy on 2024/07/29 16:02

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
39.2	12	This microlearning centers on 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
39.2	15	{{html}}
	16	<!--
30.1	17	* There are five trigger options
	18	** Error message
	19	** Log message
	20	** Queue consumers
	21	** Messages in queue
	22	** Queue throughput
39.2	23	-->
	24	{{/html}}
39.5	25	* There are four trigger options
39.2	26	** Error message
	27	** Log message
39.4	28	** Messages added to topic
	29	** Topic consumer messages behind
32.1	30	* On the trigger level, the recipients are defined
	31	* On the trigger level, the congestion control is defined
1.1	32
30.1	33	== 3. Dynamic Alerting ==
1.1	34
39.9	35	To enhance the observability of your integration landscape while running in the current generation runtime architecture, we provide a functionality in the 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. From there on, you can navigate to the "Other" tab.
1.1	36
39.15	37	Here, 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"]] that are defined by eMagiz (alerts that are non-editable) and below that (alerts that are editable), you will see all "dynamic" alerts that you and your fellow team members (with sufficient rights) can view, edit and delete.
39.9	38
39.14	39	In this page, we offer alerting on four types.
1.1	40
30.1	41	* Error message
	42	* Log message
35.1	43	* Messages added to topic
	44	* Topic consumer messages behind
1.1	45
39.17	46	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
	47
39.20	48	{{info}}As of the recent eMagiz release, we have moved the configurations for queue triggers (i.e., Queue consumers, Messages in queue, Queue throughput) to the "Queues" tab. Please refer to the [[Customize Queue alerting>>doc:Main.eMagiz Academy.Microlearnings.Novice.Alerting.novice-alerting-customize-queue-alerting.WebHome\|\|target="blank"]] microlearning to learn more on how to customize the triggers or the default values for these queues.{{/info}}
39.16	49
32.1	50	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	51
30.1	52	=== 3.1 Error message ===
1.1	53
32.1	54	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	55
32.1	56	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	57
30.1	58	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-error-message-configuration.png]]
1.1	59
30.1	60	=== 3.2 Log message ===
1.1	61
32.1	62	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	63
32.1	64	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	65
30.1	66	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
1.1	67
39.21	68	=== 3.3 Messages added to topic ===
	69
39.25	70	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. 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.
39.21	71
	72	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-all-topics.png]]
	73
39.27	74	When you press the "Add" button, a new pop-up will appear through which you can select the topics for which you want the trigger to be activated. In this pop-up, you can choose one (or more) topics and press the "Select" button to add them to the trigger. Once you have selected the topic(s) and pressed "Select," eMagiz will close the pop-up and add the topics to the trigger.
39.31	75
	76	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-topic-selection.png]]
	77
39.21	78	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.
	79
	80	=== 3.4 Topic consumer lag ===
	81
	82	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.
	83
39.29	84	{{info}}This process of adding and removing specific topics works identically as explained in the section on [[Messages added to topic.>>\|\|anchor="H3.3Messagesaddedtotopic"]]{{/info}}
39.21	85
	86	Once filled in, the solution should look similar as follows.
	87
	88	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
	89
39.32	90	=== 3.5 Recipient(s) configuration ===
39.21	91
39.33	92	You can select your recipients when you switch from the "Trigger" to the "Output" tab. In this overview, you can choose both internal recipients (i.e., eMagiz users with access into this model) and external recipients.
39.21	93
	94	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
	95
39.37	96	{{info}}Note that to add the external recipients to these four alertings discussed in this microlearning, you first need to list them via the Manage->Alerting->Triggers->Notifications settings tab. To do that, please refer to this [[page>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3\|\|target="blank"]]{{/info}}
39.21	97
39.23	98	{{html}}
	99	<!--
30.1	100	=== 3.3 Queue consumers ===
1.1	101
32.1	102	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	103
32.1	104	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	105
30.1	106	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-all-queues.png]]
1.1	107
32.1	108	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	109
30.1	110	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-specific-queues.png]]
1.1	111
32.1	112	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	113
30.1	114	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
	115
32.1	116	{{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	117
32.1	118	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	119
	120	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection-result.png]]
	121
	122	=== 3.4 Messages in queue ===
	123
32.1	124	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	125
	126	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-all-queues.png]]
	127
32.1	128	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	129
38.1	130	{{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	131
32.1	132	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	133
	134	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]]
	135
	136	=== 3.5 Queue througput ===
	137
35.1	138	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	139
	140	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
	141
32.1	142	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	143
38.1	144	{{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	145
32.1	146	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	147
	148	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
39.35	149
	150	=== 3.6 Congestion control configuration ===
	151
	152	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.
	153
	154	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]]
	155
	156	{{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}}
	157
39.21	158	-->
	159	{{/html}}
30.1	160
	161	== 4. Key takeaways ==
	162
35.1	163	* There are seven trigger options
30.1	164	** Error message
	165	** Log message
	166	** Queue consumers
	167	** Messages in queue
	168	** Queue throughput
35.1	169	** Messages added to topic
	170	** Topic consumer messages behind
32.1	171	* On the trigger level, the recipients are defined
	172	* On the trigger level, the congestion control is defined
30.1	173	* Default configuration of the congestion control is sufficient in most cases
32.1	174	* When entering multiple external recipients, ensure each email address is separated with a comma
30.1	175
	176	== 5. Suggested Additional Readings ==
	177
32.1	178	If you are interested in this topic and want more information, please read the help text provided by eMagiz.
30.1	179
17.1	180	)))((({{toc/}}))){{/container}}{{/container}}

Wiki source code of Dynamic Alerting

Navigation