Changes for page Dynamic Alerting
Last modified by Danniar Firdausy on 2024/11/19 11:08
From version 18.2
edited by Erik Bakker
on 2022/06/10 09:47
on 2022/06/10 09:47
Change comment:
Update document after refactoring.
To version 39.3
edited by Danniar Firdausy
on 2024/07/29 13:59
on 2024/07/29 13:59
Change comment:
There is no comment for this version
Summary
-
Page properties (5 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 5 removed)
- novice-alerting-linking-tags-to-triggers--example-trigger-detail-data-measurements.png
- novice-alerting-linking-tags-to-triggers--example-trigger-detail-log-entry.png
- novice-alerting-linking-tags-to-triggers--example-trigger-detail-no-tag.png
- novice-alerting-linking-tags-to-triggers--example-trigger-detail-one-tag.png
- novice-alerting-linking-tags-to-triggers--example-trigger-detail-select-tag.png
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -n ovice-alerting-linking-tags-to-triggers1 +Dynamic Alerting - Parent
-
... ... @@ -1,1 +1,1 @@ 1 -WebHome 1 +Main.eMagiz Academy.Microlearnings.Novice.Alerting.WebHome - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. ebakker1 +XWiki.dfirdausy - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,14 +1,8 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 - =LinkingTag(s)toTrigger(s)=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 -In this microlearning, we will focus on how you can link your alerting tag(s) to alerting trigger(s). 5 -In a previous microlearning we already discussed parts of this. In this microlearning we will zoom in on the Trigger section of Alerting. 6 - 7 7 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. 8 8 9 -* Last update: April 1th 2021 10 -* Required reading time: 5 minutes 11 - 12 12 == 1. Prerequisites == 13 13 14 14 * Basic knowledge of the eMagiz platform ... ... @@ -15,65 +15,168 @@ 15 15 16 16 == 2. Key concepts == 17 17 18 -This microlearning centers around linkingtag(s)to trigger(s).19 - Withlinking, we mean:Categorizeacertain triggerwiththehelpoftagfunctionality12 +This microlearning centers on configuring dynamic alerting based on triggers you can define as a user. 13 +By defining, we mean: Specifying based on what triggers an alert needs to be raised. 20 20 21 -* Make tags descriptive in nature 22 -* Re-use tags over multiple triggers that have the same aim 23 -* In case of a start, daily and end alert use the same tag for all of them 15 +{{html}} 16 +<!-- 17 +* There are five trigger options 18 +** Error message 19 +** Log message 20 +** Queue consumers 21 +** Messages in queue 22 +** Queue throughput 23 +--> 24 +{{/html}} 25 +* There are five trigger options 26 +** Error message 27 +** Log message 28 +** Queue consumers 29 +** Messages in queue 30 +** Queue throughput 24 24 32 +* On the trigger level, the recipients are defined 33 +* On the trigger level, the congestion control is defined 25 25 35 +== 3. Dynamic Alerting == 26 26 27 - ==3.Linking Tag(s)toTrigger(s)==37 +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. 28 28 29 - In our previousdalliance with this subject we already discussed partsofwhat we will discuss in this microlearning. This microlearning is mainly meant to reiterate the importance ofusing propertags when setting up your alerting.Linking the correct tag(s) to your trigger(s) will help you to clarify how the alertingstructurefor your project is set up. This is not only nice when you want to revisit thealertingsection but it is also veryusefull in communication with the business and with a support desk.This way you can create a common truth surrounding a common language. Key parts in achieving this are:39 +We offer alerting on seven types. 30 30 31 -* Make tags descriptive in nature 32 -* Re-use tags over multiple triggers that have the same aim 33 -* In case of a start, daily and end alert use the same tag for all of them 41 +* Error message 42 +* Log message 43 +* Queue consumers 44 +* Messages in queue 45 +* Queue throughput 46 +* Messages added to topic 47 +* Topic consumer messages behind 34 34 35 - To link tag(s) totrigger(s) younavigateo Manage-> Alerting> Triggers49 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]] 36 36 37 - In thisoverviewyou can simply selectaspecific trigger toseethedetailedconfiguration ofthe trigger.Depending onthe typeof triggerthat youopentheavaiableabs withinthepop-upandtheinformationshown in thepop-upcandiffer.Below we showtwo distinctexamples:51 +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). 38 38 39 - [[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-data-measurements.png]]53 +=== 3.1 Error message === 40 40 41 - [[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-log-entry.png]]55 +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. 42 42 43 - As youcanseefromtheseexamples isthat thenumberoftabs within thepop-updiffer. The firsttab is werethe configurationofthe triggerhappens.Inalltheothertabsyou needtolinkthe tag(s)to thetrigger.To do so simplypressAddin one ofthesetabs, searchfortheTagyou want to linkto thistrigger,selectit andpressSelect.57 +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. 44 44 45 -[[image:Main.Images.Microlearning.WebHome@novice-alerting- linking-tags-to-triggers--example-trigger-detail-no-tag.png]]59 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-error-message-configuration.png]] 46 46 47 - [[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-select-tag.png]]61 +=== 3.2 Log message === 48 48 49 - [[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-one-tag.png]]63 +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. 50 50 51 - Whenyouarehappywith yourselectionyou canpressSave ontriggerlevelandeMagizwilllinkthetagthetrigger.65 +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. 52 52 67 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]] 53 53 69 +=== 3.3 Queue consumers === 54 54 55 - ==4.Assignment==71 +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. 56 56 57 -Link an (extra) tag to a trigger. 58 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 73 +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. 59 59 60 - == 5.Key takeaways==75 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-all-queues.png]] 61 61 62 -* Assist in creating a common language 63 -* Make tags descriptive in nature 64 -* Re-use tags over multiple triggers that have the same aim 65 -* In case of a start, daily and end alert use the same tag for all of them 77 +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. 66 66 79 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-specific-queues.png]] 67 67 81 +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. 68 68 69 - == 6.Suggested AdditionalReadings==83 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]] 70 70 71 - If you are interestedinthis topicandwantmoreinformationonitpleaseread the helptextprovidedbyeMagiz.85 +{{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}} 72 72 73 - ==7.Silentmonstrationvideo==87 +Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger. 74 74 75 - This video demonstrateshow youcould havehandledthe assignmentandgives yousometext on what youhavejustlearned.89 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection-result.png]] 76 76 77 - {{video attachment="novice-alerting-linking-tags-to-triggers.mp4"reference="Main.Videos.Microlearning.WebHome"/}}91 +=== 3.4 Messages in queue === 78 78 93 +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. 94 + 95 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-all-queues.png]] 96 + 97 +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. 98 + 99 +{{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}} 100 + 101 +Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger. 102 + 103 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]] 104 + 105 +=== 3.5 Queue througput === 106 + 107 +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. 108 + 109 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]] 110 + 111 +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. 112 + 113 +{{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}} 114 + 115 +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. 116 + 117 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]] 118 + 119 +=== 3.6 Messages added to topic === 120 + 121 +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. 122 + 123 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-all-topics.png]] 124 + 125 +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. 126 + 127 +{{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}} 128 + 129 +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. 130 + 131 +=== 3.7 Topic consumer lag === 132 + 133 +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. 134 + 135 +{{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}} 136 + 137 +Once filled in, the solution should look similar as follows. 138 + 139 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]] 140 + 141 +=== 3.8 Recipient(s) configuration === 142 + 143 +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. 144 + 145 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]] 146 + 147 +{{info}}Note that when you define multiple external recipients, you need to separate each email address with a comma to make it work.{{/info}} 148 + 149 +=== 3.9 Congestion control configuration === 150 + 151 +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. 152 + 153 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]] 154 + 155 +{{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}} 156 + 157 +== 4. Key takeaways == 158 + 159 +* There are seven trigger options 160 +** Error message 161 +** Log message 162 +** Queue consumers 163 +** Messages in queue 164 +** Queue throughput 165 +** Messages added to topic 166 +** Topic consumer messages behind 167 +* On the trigger level, the recipients are defined 168 +* On the trigger level, the congestion control is defined 169 +* Default configuration of the congestion control is sufficient in most cases 170 +* When entering multiple external recipients, ensure each email address is separated with a comma 171 + 172 +== 5. Suggested Additional Readings == 173 + 174 +If you are interested in this topic and want more information, please read the help text provided by eMagiz. 175 + 79 79 )))((({{toc/}}))){{/container}}{{/container}}
- novice-alerting-linking-tags-to-triggers--example-trigger-detail-data-measurements.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.ebakker - Size
-
... ... @@ -1,1 +1,0 @@ 1 -0 bytes - Content
- novice-alerting-linking-tags-to-triggers--example-trigger-detail-log-entry.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.ebakker - Size
-
... ... @@ -1,1 +1,0 @@ 1 -12.7 KB - Content
- novice-alerting-linking-tags-to-triggers--example-trigger-detail-no-tag.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.ebakker - Size
-
... ... @@ -1,1 +1,0 @@ 1 -6.3 KB - Content
- novice-alerting-linking-tags-to-triggers--example-trigger-detail-one-tag.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.ebakker - Size
-
... ... @@ -1,1 +1,0 @@ 1 -0 bytes - Content
- novice-alerting-linking-tags-to-triggers--example-trigger-detail-select-tag.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.ebakker - Size
-
... ... @@ -1,1 +1,0 @@ 1 -0 bytes - Content