Customize Queue Alerting

{{container}}{{container layoutStyle="columns"}}(((

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:

** Consumers check

** Queue load check

** Inactivity check

** 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, 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.

38

39

* **Queue load check**

40

[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-queue-load-check.png]]

41

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.

42

43

* **Inactivity check**

44

[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-inactivity-check.png]]

45

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. 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.

46

** If you select the "Always" option, the next step is to configure the "Expect a message every" period. This is useful if you want to be notified when your queue has not received at least one message within a specified time frame, such as a day or more.

47

** If you select the "During time range" option, you can specify the days of the week and the starting time for the trigger to evaluate the queue. You will also need to specify the duration for which the trigger will evaluate and how frequently within that duration the queue should expect at least one message. Note that the "Expect a message every" setting must allow for at least two occurrences within the specified duration. If the queue receives a message before the end of the "Expect a message every" period, the timer will reset.

48

** In the example above, the trigger is set to evaluate from Monday to Friday, 9 am to 5 pm, and expects a message every four hours, an alert will be sent if no message is received by 1 pm. However, if a message is received at 11 am, then the timer resets, and the next check will be at 3 pm. If no message is received by then, an alert will be sent. Consequently, due to the configuration of expects a message every four hours, and considering that there are only two hours left until the configured 5 PM, the trigger for the remaining two hours will not be executed.

49

50

51

* **Periodic activity check**

52

[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-periodic-activity-check.png]]

53

This trigger checks whether at least the specified number of messages is received during the specified interval. If you enable this trigger, then you also need to specify the days of the week, the starting time, and the duration for the trigger to evaluate the queue. Next to that you need to specify the minimum number of messages that this queue is expected to receive, which if it does not reach that number then an alert will be generated.

54

55

56

=== 3.3 Customize Default Values ===

57

58

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

59

60

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

61

62

[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue-load-check.png]]

63

64

65

[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-inactivity-check-periodic-activity-check.png]]

66

67

== 4. Key takeaways ==

68

69