Changes for page Dynamic Alerting

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

From 30.1 to 31.1 From 39.21 to 39.22

From version 31.1

edited by Erik Bakker
on 2023/02/06 08:55

Change comment: There is no comment for this version

To version 39.21

edited by Danniar Firdausy
on 2024/07/29 15:20

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.ebakker
++XWiki.dfirdausy

Content

@@ -1,5 +1,5 @@
  {{container}}{{container layoutStyle="columns"}}(((
--In this microlearning, we will focus on how you can configure your own dynamic alerting by setting up triggers on events and notifiying people on it. Should you want to learn more on 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"]].
++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"]].
  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
@@ -9,9 +9,11 @@
  == 2. Key concepts ==
--This microlearning centers configuring dynamic alerting based on triggers you can define as a user.
--With defining, we mean: Specifying based on what trigger an alert needs to be raised
++This microlearning centers on configuring dynamic alerting based on triggers you can define as a user.
++By defining, we mean: Specifying based on what triggers an alert needs to be raised.
++{{html}}
++<!--
  * There are five trigger options
  ** Error message
  ** Log message
@@ -18,138 +18,160 @@
  ** Queue consumers
  ** Messages in queue
  ** Queue throughput
--* On trigger level the recipients are defined
--* On trigger level the congestion control is defined
++-->
++{{/html}}
++* There are four trigger options
++** Error message
++** Log message
++** Messages added to topic
++** Topic consumer messages behind
++* On the trigger level, the recipients are defined
++* On the trigger level, the congestion control is defined
  == 3. Dynamic Alerting ==
--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 on 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 teammembers (with sufficient rights) can view, edit and delete.
++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.
--We offer alerting on five types.
++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.
++In this page, we offer alerting on four types.
++
  * Error message
  * Log message
--* Queue consumers
--* Messages in queue
--* Queue throughput
++* Messages added to topic
++* Topic consumer messages behind
  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
--At first we will discuss the configuration of each trigger type. Subsequently we will discuss how to define which recipients will be notified and how to alter the default congestion control settings (as this is the same for each trigger type).
++{{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}}
++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).
++
  === 3.1 Error message ===
--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 specific value. This is most likely relevant when certain error message with certain characteristics (i.e. a certain header value) need to be sent to a different set of recipients.
++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.
--To define the trigger simply fill in the name of the header and the expected value. On top of that you can fill in a description that will be added to the alert that is received via eMail. Once this is filled in the configuration could look as follows.
++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.
  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-error-message-configuration.png]]
  === 3.2 Log message ===
--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 most likely when you log something on which you want to alert when it happens.
++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.
--To define the trigger simply fill in the phrase on which you want to check. On top of that you can fill in a description that will be added to the alert that is received via eMail. Once this is filled in the configuration could look as follows.
++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.
  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
--=== 3.3 Queue consumers ===
++=== 3.3 Messages added to topic ===
--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.
++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.
--To define the trigger first define the threshold on which you want to check (i.e. 2). Subsequently define whether on which queues (or all queues) you want eMagiz to check for this condition. If you want to check on all queues no further action is needed.
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-added-to-topic-all-topics.png]]
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-all-queues.png]]
++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.
--If you want to check on a specific (set of) queue(s) you can uncheck the checkbox. As a result an "Add" and a "Remove" button are displayed by eMagiz through which you can add and remove queues to the trigger.
++{{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}}
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-specific-queues.png]]
++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.
--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 select one (or more) queues and press the "Select" button to add them to the trigger.
++=== 3.4 Topic consumer lag ===
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
++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.
--{{info}}Note, that when you want to select multiple queues at once you cannot press "Enter" to Save your selection. In this case you really need to press the "Select" button to save your selection.{{/info}}
++{{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}}
--Once you have selected the queue(s) and pressed "Select" eMagiz will close the pop-up and add the queues to the trigger.
++Once filled in, the solution should look similar as follows.
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection-result.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-topic-consumer-lag-selected-topics.png]]
--=== 3.4 Messages in queue ===
++=== 3.8 Recipient(s) configuration ===
--On top of the "static" alert that is autogenerated by eMagiz on Messages in queue you can add additional "dynamic" alerts that only trigger when a queue holds more than X number of 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. If you want to check on all queues no further action is needed.
++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.
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-all-queues.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
--If you want to check on a specific (set of) queue(s) you can uncheck the checkbox. As a result an "Add" and a "Remove" button are displayed by eMagiz through which you can add and remove queues to the trigger.
++{{info}}Note that when you define multiple external recipients, you need to separate each email address with a comma to make it work.{{/info}}
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-specific-queues.png]]
++=== 3.9 Congestion control configuration ===
--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 select one (or more) queues and press the "Select" button to add them to the trigger.
++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.
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]]
--{{info}}Note, that when you want to select multiple queues at once you cannot press "Enter" to Save your selection. In this case you really need to press the "Select" button to save your selection.{{/info}}
++{{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}}
--Once you have selected the queue(s) and pressed "Select" eMagiz will close the pop-up and add the queues to the trigger.
++{{html}}
++<!--
++=== 3.3 Queue consumers ===
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]]
++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.
--=== 3.5 Queue througput ===
++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.
--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 througput 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. If you want to check on all queues no further action is needed.
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-all-queues.png]]
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
++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.
--If you want to check on a specific (set of) queue(s) you can uncheck the checkbox. As a result an "Add" and a "Remove" button are displayed by eMagiz through which you can add and remove queues to the trigger.
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-specific-queues.png]]
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-specific-queues.png]]
++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.
--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 select one (or more) queues and press the "Select" button to add them to the trigger.
--
  [[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection.png]]
--{{info}}Note, that when you want to select multiple queues at once you cannot press "Enter" to Save your selection. In this case you really need to press the "Select" button to save your selection.{{/info}}
++{{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}}
--Once you have selected the queue(s) and pressed "Select" eMagiz will close the pop-up and add the queues to the trigger.
++Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-queue-selection-result.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-queue-selection-result.png]]
--For this trigger an additional criteria can be configured that allows 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.
++=== 3.4 Messages in queue ===
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
++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.
--=== 3.6 Recipient(s) configuration ===
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-all-queues.png]]
--When you switch from the "Trigger" to the "Output" tab you can select your recipients. In this overview you can select both eMagiz users as well as external recipients.
++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.
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
++{{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}}
--{{info}}Note that when you define multiple external recipients you need to seperate each emailadress with a comma to make it work.{{/info}}
++Once you have selected the queue(s) and pressed "Select," eMagiz will close the pop-up and add the queues to the trigger.
--=== 3.7 Congestion control configuration ===
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-queue-selection-result.png]]
--In the same "Output" tab you can also define the congestion control configuration. The default configuration is that congestion control is activated and will be activated once more than ten alerts are triggered in the last ten minutes. Should you want to reduce this number you can do so here.
++=== 3.5 Queue througput ===
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]]
++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.
--{{warning}}Note, that we advise to only reduce the number under the congestion control if the default of ten is too high. We do **not** advise to deactivate the congestion control as this can cause an explosion in the number of received notifications.{{/warning}}
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-all-queues.png]]
++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.
++
++{{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}}
++
++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.
++
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
++-->
++{{/html}}
++
  == 4. Key takeaways ==
--* There are five trigger options
++* There are seven trigger options
  ** Error message
  ** Log message
  ** Queue consumers
  ** Messages in queue
  ** Queue throughput
--* On trigger level the recipients are defined
--* On trigger level the congestion control is defined
++** Messages added to topic
++** Topic consumer messages behind
++* On the trigger level, the recipients are defined
++* On the trigger level, the congestion control is defined
  * Default configuration of the congestion control is sufficient in most cases
--* When entering multiple external recipients ensure each email address is seperated with a comma
++* When entering multiple external recipients, ensure each email address is separated with a comma
  == 5. Suggested Additional Readings ==
--If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
++If you are interested in this topic and want more information, please read the help text provided by eMagiz.
  )))((({{toc/}}))){{/container}}{{/container}}

Changes for page Dynamic Alerting

Summary

Details

Navigation