Changes for page Customize Queue Alerting

Last modified by Danniar Firdausy on 2024/09/04 15:45

From 30.1 to 31.1 From 43.41 to 43.42

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 43.41

edited by Danniar Firdausy
on 2024/07/23 11:46

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Dynamic Alerting
++Customize Queue Alerting

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 customize your queue alerts by configuring the trigger conditions and thresholds, which raise an alert and notify people when those points are passed. 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"]]. Note that the queue alerting explained in this page is only applicable for eMagiz models that are running the current generation runtime architecture.
  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
@@ -6,150 +6,70 @@
  == 1. Prerequisites ==
  * Basic knowledge of the eMagiz platform
++* Basic knowledge of alerting in the eMagiz platform
  == 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 focuses on customizing the queue alerts for each environment (i.e., Testing-Acceptance-Production) in your model. By customizing: we mean further configuring the trigger conditions and thresholds of your queues from the general default settings provided by eMagiz, so they better suit your needs and requirements.
--* There are five 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
++* eMagiz applies the same set of triggers to all JMS queues.
++* There are four queue trigger options that eMagiz currently provides:
++** Consumers check
++** Queue load check
++** Inactivity check
++** Periodic activity check
++* Recipients are defined on the queue level.
--== 3. Dynamic Alerting ==
++== 3. Queue Alerting ==
++=== 3.1 Queue Alerting Overview ===
++In principle, queue alerting refers to the configuration of alerts that work by applying a uniform set of triggers to all queues in your model. By queues here, we mean all queues that are generated by eMagiz and existing in the Create phase of your model. Out-of-the-box, eMagiz provides the default values that are suitable for the topology of each of your model environments (Testing-Acceptance-Production). By topology here, we refer whether your environment is running on single-lane or double-lane setup. In the screenshot below, you can find the overview of your queue alerts by navigating to Manage -> Alerting -> Triggers.
--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.
++[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-manage-alerting-in-emagiz-queue-alerts-overview.png]]
--We offer alerting on five types.
++Here, you will find all the queues that are generated by eMagiz and currently existing in the Create phase of your model, along with the trigger conditions and thresholds that are applied to each of these queues. In the following sections, we will discuss how you can tune these queue triggers to your needs.
--* Error message
--* Log message
--* Queue consumers
--* Messages in queue
--* Queue throughput
++=== 3.2 Customize Queue Alerting ===
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-trigger-options.png]]
++To customize these queue triggers to better suit your needs, you can click the edit buttons (green paper and pencil buttons) that find at the end of each queue trigger. By doing so, you will get a pop-up page that allows you to further customize the conditions and thresholds of your queue triggers.
--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).
++  * **Consumers check**
++  [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue.png]]
++This trigger checks how many processes (consumers) are subscribing to and retrieving messages from a particular queue over the last 10 minutes. It evaluates whether the number of consumers meets the specified threshold. If the number of consumers falls below the "Expected consumers" value, an alert is generated. You can customize this threshold as needed. Additionally, you can specify the instructions to be included in email notifications sent to recipients and in the alert message displayed in the Manage->Alerting->Alerts.
--=== 3.1 Error message ===
++  * **Queue load check**
++  [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-queue-load-check.png]]
++This trigger checks how many messages are produced on a particular queue and not yet retrieved by any consumers over the last 10 minutes. It evaluates whether the number of messages on the queue is below the specified threshold. If the number of messages is greater than the "Max messages queued" value, an alert is generated. You can customize this threshold as needed. Additionally, you can specify the instructions to be included in email notifications sent to recipients and in the alert message displayed in the Manage->Alerting->Alerts. It is important to note that if high bursts of messages occur regularly (e.g., during nightly batch processing, 1000 messages are expected to be produced to a certain queue), then setting a higher threshold (e.g., 1000 Max messages queued) can prevent false-positive alerts caused by more than 100 messages being queued during a duration of 10 minutes.
++
++  * **Inactivity check**
++  [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-inactivity-check.png]]
++This trigger checks whether a particular queue receives at least one message regularly or within a specified duration that you can configure. With this trigger, you specify whether you want to 'always' have the check running everyday or only during a specified time range.
++** If you select the Always option, then the next thing you need to configure is the Expect a message every a certain period of time. This can be useful if you want to be notified when your queue has not received at least one message within a day or more days.
++** If you select the During time range option, you can select in which days of the week the trigger will evaluate and starting from what time of those selected days it will start evaluating. With this, you will need to specify for how long is the duration that the trigger will be evaluating as well as every how often within that duration that the queue expects at least a message. Note that this "Expect a message every" configuration requires that it should fit at least 2 times occurances in the duration.
++
++  * **Periodic activity check**
++  [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-periodic-activity-check.png]]
++  aa
--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.
--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.
++=== 3.3 Customize Default Values ===
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-error-message-configuration.png]]
++Next to that, you can also customize the default values of your queue triggers to better suit the requirements of each environment of your model, as well as modify the trigger conditions and thresholds for each queue. To customize the default values that eMagiz has configured by default, you can click the "Configure defaults" button on top of this list. You will see
--=== 3.2 Log message ===
++The "Configure defaults" button above the list of these queue triggers (or "View defaults" depending if your account does not have the edit rights on Manage) to customize the default values of your queue triggers
--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.
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue-load-check.png]]
--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.
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-log-message-configuration.png]]
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-inactivity-check-periodic-activity-check.png]]
--=== 3.3 Queue consumers ===
--
--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.
--
--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-queue-consumers-all-queues.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.
--
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-consumers-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 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}}
--
--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-consumers-queue-selection-result.png]]
--
--=== 3.4 Messages in queue ===
--
--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.
--
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-all-queues.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.
--
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-messages-in-queue-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 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}}
--
--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-messages-in-queue-queue-selection-result.png]]
--
--=== 3.5 Queue througput ===
--
--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-throughput-all-queues.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.
--
--[[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 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}}
--
--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]]
--
--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.
--
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-queue-throughput-occurence-config.png]]
--
--=== 3.6 Recipient(s) configuration ===
--
--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.
--
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-recipient-config.png]]
--
--{{info}}Note that when you define multiple external recipients you need to seperate each emailadress with a comma to make it work.{{/info}}
--
--=== 3.7 Congestion control configuration ===
--
--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.
--
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-dynamic-alerting--dynamic-alert-congestion-control-config.png]]
--
--{{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}}
--
  == 4. Key takeaways ==
--* There are five 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
--* 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
++* a
++* b
++* c
  == 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 Customize Queue Alerting

Summary

Details

Navigation