Skip to Content

Changes for page Topic Alerting

Last modified by Erik Bakker on 2025/11/19 20:30
From version 66.1
edited by Erik Bakker
on 2025/09/15 11:44
Change comment: There is no comment for this version
To version 43.14
edited by dfirdausy
on 2024/07/22 15:31
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Topic Alerting
1 +Customize Queue Alerting
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.dfirdausy
Content
... ... @@ -1,10 +1,8 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we’ll explore how to view and customize topic alerts within your eMagiz environment. Customizing these alerts allows you to tailor the trigger conditions and thresholds to better fit your specific needs, enhancing how you monitor and respond to topic activity. We’ll cover the two types of topic triggers available and guide you through configuring them to suit your requirements. This will help you ensure your alerts are as effective and relevant as possible. 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"]].
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 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 -{{info}}Note that this documentation explains the latest design of eMagiz Topic Alerting that is introduced in [[Release 253>>Main.Release Information.Release Blogs.253 - Changing Chameleon||target="blank"]] and the Topic Alerting explained in this page is only applicable for eMagiz models that are running on DSH.{{/info}}
7 -
8 8  == 1. Prerequisites ==
9 9  
10 10  * Basic knowledge of the eMagiz platform
... ... @@ -12,69 +12,56 @@
12 12  
13 13  == 2. Key concepts ==
14 14  
15 -This microlearning focuses on customizing the topic alerts that are existing in each of the environment of your model (i.e., Testing-Acceptance-Production). By customizing we mean further configuring the trigger conditions and thresholds of your topics, so they better suit your needs and requirements.
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.
16 16  
17 -* eMagiz applies the same set of triggers to all topic.
18 -* There are two topic trigger options that eMagiz currently provides:
19 -** Minimum throughput check
20 -** Messages behind check
21 -* Recipients are defined on the topic level.
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 22  
23 -== 3. Topic Alerting ==
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.
24 24  
25 -As all our alerting now works is that we have divided them up in various segments that are accessible via Manage.
27 +[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-manage-alerting-in-emagiz-queue-alerts-overview.png]]
26 26  
27 -[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-manage-alerting-in-emagiz-topic-alerts-overview.png]]
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.
28 28  
29 -Here, when you navigate to Manage->Alerting->Triggers, you will find all the topics that are generated by eMagiz currently existing within your model, along with the trigger conditions and thresholds that are applied to each of these topics. In the following sections, we will discuss how you can tune these topics triggers to your needs.
31 +=== 3.2 Customize Queue Alerting ===
30 30  
31 -{{info}}Contrary to the queue alerting we do not offer any default configuration as eMagiz given the widespread implementation of event streaming in the community which prevents us from defining relevant default triggers that would apply in almost all cases. As a result, the default configuration on topic level is that the alert is **disabled** and **no** thresholds are defined{{/info}}
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 see the pop-up page as shown below as an example.
32 32  
33 -=== 3.1 Customize Default Values ===
35 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue.png]]
34 34  
35 -Changes to the default values will only apply to topic triggers that are set to use the default values, and not to those you have already customized. To modify the default values configured by eMagiz, you can click the "Configure defaults" button at the top of the topic trigger list.
37 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-inactivity-check.png]]
36 36  
37 -{{info}}Note that if your account does not have edit rights in Manage for a specific environment, you will see a "View defaults" button instead.{{/info}}
39 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-periodic-activity-check.png]]
38 38  
39 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-topic-alerting--customize-default-triggers.png]]
41 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-queue-load-check.png]]
40 40  
41 -Here, you will get a pop-up page where you can configure the default values of your topic triggers. The details of each of the triggers will be discussed in the next section. But, what is important to note here is that, here, you have the "Reset to eMagiz defaults" button to reset the default values to the values provided by eMagiz as defaults (i.e. disabling them). Next to that, at the bottom of the pop-up, you will find the "Update defaults" button, which will apply the default values that you have configured to all topic triggers that are set to use the default values. By clicking this button, the new default values will be put into effect immediately.
42 42  
43 -Additionally, on this page, you can also find the "Notifications" tab that allows you to configure which recipients that you want to receive the notifications from the alerting. If you want to learn more about this notifications and how to configure it, please refer to this [[microlearning>>Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3||target="blank"]].
44 +=== 3.3 Customize Default Values ===
44 44  
45 -=== 3.2 Customize Topic Alerting ===
46 +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
46 46  
47 -Next to customizing the default values for all topic triggers, you can also modify the trigger configurations for individual topics. To customize these topic triggers to better suit your needs, you can click the edit buttons (green paper and pencil buttons) located at the end of each topic trigger. By doing so, you will get a pop-up page that allows you to further customize the conditions and thresholds of your topic triggers, which will be discussed in the following.
48 +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
48 48  
49 -==== 3.2.1 Minimum throughput check ====
50 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue-load-check.png]]
50 50  
51 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-topic-alerting--minimum-throughput-check.png]]
52 52  
53 -{{info}}This alert checks whether a topic receives at least the specified number of messages within a 10-minute window. If the count remains below the threshold for the entire window, a Problem alert is triggered. Please provide the threshold that suites the integration. 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.{{/info}}
53 +[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-inactivity-check-periodic-activity-check.png]]
54 54  
55 -==== 3.2.2 Messages behind check ====
56 -
57 -[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-topic-alerting--messages-behind-check.png]]
58 -
59 -{{info}}This alert monitors consumer lag and triggers a Problem alert if any consumer group exceeds the defined threshold for 10 consecutive minutes. Please provide the threshold that suites the integration. For more information check out the helptext on the component{{/info}}
60 -
61 -
62 -{{info}}Upon saving, these custom values will apply immediately, putting the new check into effect. Additionally, you will notice that the "Settings" status of the topic trigger you just customized has changed from "Default" to "Custom". Similarly, on this page, you can also find the "Notifications" tab that allows you to configure which recipients that you want to receive the notifications from the alerting of a specific topic. If you want to learn more about this notifications and how to configure it, please refer to this [[microlearning>>Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3||target="blank"]].{{/info}}
63 -
64 64  == 4. Key takeaways ==
65 65  
66 -* As a user with the edit rights in Manage of a particular environment, you can modify the default values for all of your topic triggers or customize the trigger configurations of individual topics.
67 -* eMagiz provides four topic trigger options: Minimum throughput check (monitoring the number of messages processed by the topic), Messages behind check (monitoring the consumer lag).
68 -* Once you save your trigger configurations, they will take effect immediately.
57 +* a
58 +* b
59 +* c
69 69  
70 70  == 5. Suggested Additional Readings ==
71 71  
72 -If you are interested in this topic and want more information, please read the help text provided by eMagiz and read the following microlearning.
73 -* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
74 -** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
75 -*** [[Standard Alerting eMagiz (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]]
76 -* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
77 -** [[Alerting (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.WebHome||target="blank"]]
78 -*** [[Setting up notifications (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3||target="blank"]]
79 -* [[Topic Alerting (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22topic+alerting%22||target="blank"]]
63 +If you are interested in this topic and want more information, please read the help text provided by eMagiz.
64 +
80 80  )))((({{toc/}}))){{/container}}{{/container}}