Changes for page Topic Alerting

Summary

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

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

Content

...	...	@@ -1,9 +1,9 @@
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 or the general concept of eMagiz Queue Alerting, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]].
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}}
	6	+{{info}}Note that this documentation explains the latest design of eMagiz Queue Alerting that is introduced in [[Release 226>>Main.Release Information.Release Blogs.226 - Alerting Alchemy||target="blank"]] and the Queue Alerting explained in this page is only applicable for eMagiz models that are running the [[current generation runtime architecture>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]{{/info}}
7	7
8	8	== 1. Prerequisites ==
9	9
...	...	@@ -12,41 +12,38 @@
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.
	15	+This microlearning focuses on customizing the queue 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 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.
	17	+* eMagiz applies the same set of triggers to all queues.
	18	+* There are four queue trigger options that eMagiz currently provides:
	19	+** Consumers check
	20	+** Queue load check
	21	+** Inactivity check
	22	+** Periodic activity check
	23	+* Recipients are defined on the queue level.
22	22
23		-== 3. Topic Alerting ==
	25	+== 3. Queue Alerting ==
	26	+As discussed in the previous [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-alerting-gen3||target="blank"]], queue alerting refers to the configuration of alerts that work by applying a uniform set of triggers to all queues in your model.
24	24
25		-As all our alerting now works is that we have divided them up in various segments that are accessible via Manage.
	28	+[[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]]
	30	+Here, when you navigate to Manage->Alerting->Triggers, you will find all the queues that are generated by eMagiz currently existing within 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.
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}}
32		-
33	33	=== 3.1 Customize Default Values ===
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.
	34	+Changes to the default values will only apply to queue 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 queue trigger list. Note that if your account does not have edit rights in Manage for a specific environment, you will see a "View defaults" button instead.
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}}
	36	+[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue-load-check.png]]
38	38
39		-[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-topic-alerting--customize-default-triggers.png]]
	38	+Here, you will get a pop-up page where you can configure the default values of your queue 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. Next to that, at the end of the page, you will find the "Update defaults" button, which will apply the default values that you have configured to all queue triggers that are set to use the default values. By clicking this button, the new default values will be put into effect immediately.
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		-
43	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	44
45		-=== 3.2 Customize Topic Alerting ===
	42	+=== 3.2 Customize Queue Alerting ===
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.
	44	+Next to customizing the default values for each queue triggers, you can also modify the trigger configurations for individual queues. To customize these queue triggers to better suit your needs, you can click the edit buttons (green paper and pencil buttons) located 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, which will be discussed in the following.
48	48
49		-==== 3.2.1 Minimum throughput check ====
	46	+* **Consumers check**
50	50	[[image:Main.Images.Microlearning.WebHome@novice-alerting-customize-queue-alerting-consumers-check-queue.png]]
51	51
52	52	{{info}}This trigger checks how many processes (consumers) are subscribing to and retrieving messages from a particular queue over the last ten minutes. It evaluates whether the number of consumers meets the specified threshold. If the number of consumers falls consistently **below** the "Expected consumers" value for a period of ten minutes, 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.{{/info}}
...	...	@@ -89,5 +89,4 @@
89	89	* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
90	90	** [[Alerting (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.WebHome||target="blank"]]
91	91	*** [[Setting up notifications (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Alerting.intermediate-alerting-setting-up-notifications-gen3||target="blank"]]
92		-* [[Queue 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=%22queue+alerting%22||target="blank"]]
93	93	)))((({{toc/}}))){{/container}}{{/container}}