Wiki source code of Customize Queue Alerting

Version 43.25 by Danniar Firdausy on 2024/07/22 15:56

Show last authors
1 {{container}}{{container layoutStyle="columns"}}(((
2 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.
3
4 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5
6 == 1. Prerequisites ==
7
8 * Basic knowledge of the eMagiz platform
9 * Basic knowledge of alerting in the eMagiz platform
10
11 == 2. Key concepts ==
12
13 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.
14
15 * eMagiz applies the same set of triggers to all JMS queues
16 * There are four queue trigger options that eMagiz currently provides:
17 ** Consumers check
18 ** Queue load check
19 ** Inactivity check
20 ** Periodic activity check
21 * Recipients are defined on the queue level.
22
23 == 3. Queue Alerting ==
24 === 3.1 Queue Alerting Overview ===
25 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.
26
27 [[image:Main.Images.Microlearning.WebHome@crashcourse-platform-manage-alerting-in-emagiz-queue-alerts-overview.png]]
28
29 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.
30
31 === 3.2 Customize Queue Alerting ===
32
33 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.
34
35 * Consumers check
36 [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue.png]]
37 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, which you customize this threshold as needed, an alert is generated. Additionally, you can specify the instructions to be included in email notifications sent to recipients and in the alert message displayed during the manage phase.
38
39 * Queue load check
40 [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-queue-load-check.png]]
41 aa
42
43 * Inactivity check
44 [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-inactivity-check.png]]
45 aa
46
47 * Periodic activity check
48 [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-periodic-activity-check.png]]
49 aa
50
51
52 === 3.3 Customize Default Values ===
53
54 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
55
56 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
57
58 [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue-load-check.png]]
59
60
61 [[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-inactivity-check-periodic-activity-check.png]]
62
63 == 4. Key takeaways ==
64
65 * a
66 * b
67 * c
68
69 == 5. Suggested Additional Readings ==
70
71 If you are interested in this topic and want more information, please read the help text provided by eMagiz.
72
73 )))((({{toc/}}))){{/container}}{{/container}}