Changes for page Customize Queue Alerting

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

From 28.1 to 29.1 From 43.47 to 43.48

From version 29.1

edited by Erik Bakker
on 2023/02/03 10:49

Change comment: There is no comment for this version

To version 43.47

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

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,62 +6,71 @@
  == 1. Prerequisites ==
  * Basic knowledge of the eMagiz platform
++* Basic knowledge of alerting in the eMagiz platform
  == 2. Key concepts ==
--This microlearning centers around linking tag(s) to trigger(s).
--With linking, we mean: Categorize a certain trigger with the help of tag functionality
++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.
--* Make tags descriptive in nature
--* Re-use tags over multiple triggers that have the same aim
--* In case of a start, daily and end alert use the same tag for all of them
++* 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. Linking Tag(s) to Trigger(s) ==
++== 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.
--In our previous dalliance with this subject we already discussed parts of what we will discuss in this microlearning. This microlearning is mainly meant to reiterate the importance of using proper tags when setting up your alerting. Linking the correct tag(s) to your trigger(s) will help you to clarify how the alerting structure for your project is set up. This is not only nice when you want to revisit the alerting section but it is also very usefull 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:
++[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-manage-alerting-in-emagiz-queue-alerts-overview.png]]
--* Make tags descriptive in nature
--* Re-use tags over multiple triggers that have the same aim
--* In case of a start, daily and end alert use the same tag for all of them
++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.
--To link tag(s) to trigger(s) you navigate to Manage -> Alerting -> Triggers
++=== 3.2 Customize Queue Alerting ===
--In this overview you can simply select a specific trigger to see the detailed configuration of the trigger. Depending on the type of trigger that you open the avaiable tabs within the pop-up and the information shown in the pop-up can differ. Below we show two distinct examples:
++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.
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-data-measurements.png]]
++  * **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.
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-log-entry.png]]
++  * **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 with this option, the "Expect a message every" configuration requires that it should fit at least 2 times occurances in the duration. This also means that if the queue receives a message before the end of the configured "Expect a message every" timeframe, then the timer will reset without waiting for the end of that timeframe.
++In the example above, the trigger will check the queue on Monday until Friday starting from 9 am until 5 pm (due to the duration of 8 hours) and if there is no message being produced to this queue every 4 hours (i.e., no message until 1 pm) then send an alert. However, if the queue receives a message before that 4 hours, e.g., at 11 am, then the timer will reset again for another 4 hours from 11 am that will check until 4 pm before it raises an alert if there is no more incoming message.
++
++  * **Periodic activity check**
++  [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-periodic-activity-check.png]]
++  aa
--As you can see from these examples is that the number of tabs within the pop-up differ. The first tab is were the configuration of the trigger happens. In all the other tabs you need to link the tag(s) to the trigger. To do so simply press Add in one of these tabs, search for the Tag you want to link to this trigger, select it and press Select.
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-no-tag.png]]
++=== 3.3 Customize Default Values ===
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-select-tag.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
--[[image:Main.Images.Microlearning.WebHome@novice-alerting-linking-tags-to-triggers--example-trigger-detail-one-tag.png]]
++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
--When you are happy with your selection you can press Save on trigger level and eMagiz will link the tag to the trigger.
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue-load-check.png]]
--== 4. Assignment ==
--Link an (extra) tag to a trigger.
--This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
++[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-inactivity-check-periodic-activity-check.png]]
--== 5. Key takeaways ==
++== 4. Key takeaways ==
--* Assist in creating a common language
--* Make tags descriptive in nature
--* Re-use tags over multiple triggers that have the same aim
--* In case of a start, daily and end alert use the same tag for all of them
++* a
++* b
++* c
--== 6. Suggested Additional Readings ==
++== 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.
--== 7. Silent demonstration video ==
--
--This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned.
--
--{{video attachment="novice-alerting-linking-tags-to-triggers.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
--
  )))((({{toc/}}))){{/container}}{{/container}}

Changes for page Customize Queue Alerting

Summary

Details

Navigation