Wiki source code of Dynamic Alerting

Last modified by Danniar Firdausy on 2024/11/19 11:08

version	line-number	content
17.1	1	{{container}}{{container layoutStyle="columns"}}(((
46.1	2	In this microlearning, we'll dive into configuring dynamic alerting in eMagiz. Dynamic alerts allow you to set up notifications based on specific triggers you define, helping you stay on top of critical events in your integration landscape. You can create alerts for error messages, log messages, topic updates, and consumer lag, and customize who gets notified. We’ll walk you through the different types of triggers and how to set them up effectively. 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
49.2	15	* There are three trigger options
39.2	16	** Log message
39.4	17	** Messages added to topic
	18	** Topic consumer messages behind
32.1	19	* On the trigger level, the recipients are defined
39.40	20
30.1	21	== 3. Dynamic Alerting ==
1.1	22
49.1	23	To enhance the observability of your integration landscape while running in the current generation 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	24
39.15	25	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	26
49.4	27	In this page, we offer dynamic alerting on three different types.
1.1	28
30.1	29	* Log message
35.1	30	* Messages added to topic
	31	* Topic consumer messages behind
1.1	32
39.17	33	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
	34
49.8	35	{{info}}As of the recent eMagiz releases, we have moved the configurations for queue triggers (i.e., Queue consumers, Messages in queue, and Queue throughput) to the "Queues" tab and error alerting (i.e., Error message and Check header) to the "Errors" tab. Please refer to the [[Customize Queue alerting>>doc:Main.eMagiz Academy.Microlearnings.Novice.Alerting.novice-alerting-customize-queue-alerting.WebHome\|\|target="blank"]] and [[Error Alerting>>doc:Main.eMagiz Academy.Microlearnings.Novice.Alerting.novice-alerting-error-alerting.WebHome\|\|target="blank"]] microlearnings.{{/info}}
39.16	36
32.1	37	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	38
49.4	39	{{html}}
	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]]
49.4	48	-->
	49	{{/html}}
1.1	50
49.6	51	=== 3.1 Log message ===
1.1	52
32.1	53	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	54
32.1	55	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	56
30.1	57	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
1.1	58
49.6	59	=== 3.2 Messages added to topic ===
39.21	60
39.25	61	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	62
	63	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-all-topics.png]]
	64
39.27	65	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	66
	67	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-topic-selection.png]]
	68
39.21	69	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.
	70
49.6	71	=== 3.3 Topic consumer lag ===
39.21	72
	73	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.
	74
39.29	75	{{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	76
	77	Once filled in, the solution should look similar as follows.
	78
	79	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
	80
49.6	81	=== 3.4 Recipient(s) configuration ===
39.21	82
39.51	83	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 that is part of your company or has access to the model in question) and external recipients.
39.21	84
	85	[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
	86
39.37	87	{{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	88
30.1	89	== 4. Key takeaways ==
	90
49.2	91	* There are three trigger options that eMagiz provides for dynamic alerting:
30.1	92	** Log message
35.1	93	** Messages added to topic
	94	** Topic consumer messages behind
39.47	95	* On the trigger level, the recipients are defined.
39.49	96	* When entering multiple external recipients for these dynamic alerting triggers, ensure that you have listed them in the Manage->Alerting->Triggers->Notifications settings tab.
39.44	97
30.1	98	== 5. Suggested Additional Readings ==
	99
42.1	100	* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome\|\|target="blank"]]
	101	** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome\|\|target="blank"]]
	102	*** [[Standard Alerting eMagiz (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3\|\|target="blank"]]
44.1	103	* [[Novice (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome\|\|target="blank"]]
	104	** [[Alerting (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Alerting.WebHome\|\|target="blank"]]
	105	* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome\|\|target="blank"]]
	106	** [[Alerting (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.WebHome\|\|target="blank"]]
	107	*** [[Setting up notifications (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3\|\|target="blank"]]
47.1	108	* [[Dynamic Alerting (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22dynamic+alerting%22\|\|target="blank"]]
44.1	109
17.1	110	)))((({{toc/}}))){{/container}}{{/container}}

Wiki source code of Dynamic Alerting

Navigation