Changes for page Customize Queue Alerting
Last modified by Danniar Firdausy on 2024/09/04 15:45
From version 40.2
edited by Danniar Firdausy
on 2024/07/18 13:20
on 2024/07/18 13:20
Change comment:
There is no comment for this version
To version 34.1
edited by Erik Bakker
on 2023/02/07 13:41
on 2023/02/07 13:41
Change comment:
There is no comment for this version
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - CustomizeQueueAlerting1 +Dynamic Alerting - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. dfirdausy1 +XWiki.ebakker - Content
-
... ... @@ -1,5 +1,5 @@ 1 1 {{container}}{{container layoutStyle="columns"}}((( 2 -In this microlearning, we will focus on how you can c ustomize yourqueuealerting 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"]].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 4 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. 5 5 ... ... @@ -25,7 +25,7 @@ 25 25 26 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. 27 27 28 -We offer alerting on seventypes.28 +We offer alerting on five types. 29 29 30 30 * Error message 31 31 * Log message ... ... @@ -32,8 +32,6 @@ 32 32 * Queue consumers 33 33 * Messages in queue 34 34 * Queue throughput 35 -* Messages added to topic 36 -* Topic consumer messages behind 37 37 38 38 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]] 39 39 ... ... @@ -85,8 +85,14 @@ 85 85 86 86 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. 87 87 88 - {{info}}Thisprocess ofaddingand removing specific queues worksidentically, asexplainedinhectionon Queueconsumers.[[Queueconsumers.>>||anchor="H3.3Queueconsumers"]]{{/info}}86 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-specific-queues.png]] 89 89 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. 89 + 90 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]] 91 + 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}} 93 + 90 90 Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger. 91 91 92 92 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]] ... ... @@ -93,42 +93,30 @@ 93 93 94 94 === 3.5 Queue througput === 95 95 96 - For thiscategoryyou 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.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. 97 97 98 98 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]] 99 99 100 100 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. 101 101 102 - {{info}}Thisprocess ofaddingand removing specific queues worksidentically, asexplainedinthe section on Queueconsumers.[[Queueconsumers.>>||anchor="H3.3Queueconsumers"]]{{/info}}106 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-specific-queues.png]] 103 103 104 - Forthis trigger,additionalcriteriacanbeconfiguredthat allow youtodefinewheneMagiz needstovalidatethisconfiguration(i.e.,Occurence). With thehelpofthisconfiguration option, you canspecify whenthetriggerneedstobeevaluated.AnexampleouldbeonlyonMondaybetween04:00AMand 05:00 AM.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. 105 105 106 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue- throughput-occurence-config.png]]110 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]] 107 107 108 - ===3.6Messages addedto topic===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}} 109 109 110 - For thiscategory,youcan add additional "dynamic" alerts.Thesealerts only trigger when the messages addedto one or more topic is less than X messagesper Y minutes.Ontopof the numberof messages (X) andthetimeframe (Y), youcan define whetherto validatethis onaspecifictopic or alltopics. Note that thedefault configurationis thatthealert applies toalltopics.114 +Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger. 111 111 112 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert- messages-added-to-topic-all-topics.png]]116 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-queue-selection-result.png]] 113 113 114 -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. 115 - 116 -{{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}} 117 - 118 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. 119 119 120 - === 3.7 Topicconsumer===120 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]] 121 121 122 - Forthiscategory, youcan add additional "dynamic" alerts. These alerts onlytrigger when one(or more) consumer groups lag by X messages on one (or more)topic(s). Note that the default configurationis that you, as a user, need to specify for which topic(s) the alert applies, as consumers' behavior can vary widely.122 +=== 3.6 Recipient(s) configuration === 123 123 124 -{{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}} 125 - 126 -Once filled in, the solution should look similar as follows. 127 - 128 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]] 129 - 130 -=== 3.8 Recipient(s) configuration === 131 - 132 132 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. 133 133 134 134 [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]] ... ... @@ -135,7 +135,7 @@ 135 135 136 136 {{info}}Note that when you define multiple external recipients, you need to separate each email address with a comma to make it work.{{/info}} 137 137 138 -=== 3. 9Congestion control configuration ===130 +=== 3.7 Congestion control configuration === 139 139 140 140 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. 141 141 ... ... @@ -145,14 +145,12 @@ 145 145 146 146 == 4. Key takeaways == 147 147 148 -* There are seventrigger options140 +* There are five trigger options 149 149 ** Error message 150 150 ** Log message 151 151 ** Queue consumers 152 152 ** Messages in queue 153 153 ** Queue throughput 154 -** Messages added to topic 155 -** Topic consumer messages behind 156 156 * On the trigger level, the recipients are defined 157 157 * On the trigger level, the congestion control is defined 158 158 * Default configuration of the congestion control is sufficient in most cases