Changes for page Log Alerting

Summary

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

Details

Page properties

Content

...	...	@@ -10,60 +10,49 @@
10	10
11	11	== 2. Key concepts ==
12	12
13		-This microlearning focuses on creating and customizing the error alerts that are existing in each of the environment of your model (i.e., Testing-Acceptance-Production).
	13	+This microlearning focuses on creating and customizing the log alerts that are existing in each of the environment of your model (i.e., Testing-Acceptance-Production).
14	14
15		-* There are four checks that eMagiz currently provides that will raise an alert from the error messages:
16		-** Message header
17		-** Exception class
18		-** Exception message
	15	+* There are three checks that eMagiz currently provides that will raise an alert from the log messages:
	16	+** log message
	17	+** log level
19	19	** Runtime check
20		-* Recipients are defined on each error alert trigger.
	19	+* Recipients are defined on each log alert trigger.
21	21
22		-== 3. Error Alerting ==
23		-Error alerting refers to the configuration of triggers that will generate an alert, as well as send you a notification, whenever error messages with certain conditions are raised. This functionality is most likely relevant when an alert needs to be generated whenever a specific error message with certain characteristics (e.g., a particular header value or a particular exception message) is raised and that alert needs to be sent to a different set of recipients.
	21	+== 3. log Alerting ==
	22	+Log alerting refers to the configuration of triggers that will generate an alert, as well as send you a notification, whenever log entries with certain conditions are raised. This functionality is most likely relevant when an alert needs to be generated whenever a specific log entry with certain characteristics (e.g., a particular log level or a particular log message) is raised and that alert needs to be sent to a different set of recipients.
24	24
25	25	[[image:Main.Images.Microlearning.WebHome@novice-alerting-error-alerts-overview.png]]
26	26
27		-Similar to the queue alerting, you can find the overview of the error alerting by navigating to Manage->Alerting->Triggers, then under the "Errors" tab you will find all of the error alert triggers, if you have created them already, for the environment that you are working with at the moment (i.e., Testing, Acceptance, Production). To create a new error trigger, you can press the "Add" button. Otherwise, if you want to edit an existing error alert trigger, you can click the green edit button on the right side of each trigger.
	26	+Similar to the error alerting, you can find the overview of the log alerting by navigating to Manage->Alerting->Triggers, then under the "Logs" tab you will find all of the log alert triggers, if you have created them already, for the environment that you are working with at the moment (i.e., Testing, Acceptance, Production). To create a new log trigger, you can press the "Add" button. Otherwise, if you want to edit an existing log alert trigger, you can click the green edit button on the right side of each trigger.
28	28
29		-eMagiz currently provides four checks that will raise an alert from the error messages, namely, by evaluating the Message header, Exception class, Exception message, and the Runtime where the error message is raised. In the following sections, we will discuss how you can create an error trigger and tune its trigger checks to match your needs.
	28	+eMagiz currently provides three checks that will raise an alert from the log entries, namely, by evaluating the log message, Log level, and the Runtime where the log entry is raised. In the following sections, we will discuss how you can create an log trigger and tune its trigger checks to match your needs.
30	30
31		-{{info}}When setting up the error alert triggers, these considerations apply:
32		-* An alert will be generated for an error message only if all checks and conditions specified in a trigger apply.
33		-* If all checks in a trigger is set to "Ignore", then you will get an alert for every error message that is raised.
	30	+{{info}}When setting up the log alert triggers, these considerations apply:
	31	+* An alert will be generated for an log entry only if all checks and conditions specified in a trigger apply.
	32	+* If the Evaluate log message setting is set to "Ignore", then you will get an alert for **every** log message for the specified runtimes, the "Ignore" setting can only be applied for Log Level "Error"
34	34	{{/info}}
35	35
36		-=== 3.1 Evaluate message header ===
	35	+=== 3.1 Evaluate log message ===
37	37
38		-This check evaluates whether an alert should be generated when an error message is raised based on the header contained in the message.
	37	+This check evaluates whether an alert should be generated when an log entry is raised based on the contents of the log message.
39	39
40	40	[[image:Main.Images.Microlearning.WebHome@novice-alerting-error-alerts-evaluate-message-header.png]]
41	41
42		-If you set it to "Ignore", then message headers will not be evaluated when deciding whether to raise an alert. If set to "By Condition," then you can specify what header name to evaluate and define conditions such as whether it equals, does not equal, contains, or does not contain a specific value to result in an alert.
	41	+If you set it to "Ignore", then log message will not be evaluated when deciding whether to raise an alert. If set to "By Condition," then you can specify what value to evaluate and define conditions such as whether it equals, does not equal, contains, or does not contain within the log message.
43	43
44		-=== 3.2 Evaluate exception class ===
	43	+=== 3.2 Log level ===
45	45
46		-This check evaluates whether an alert should be generated based on the exception class of the error message when it is raised.
	45	+This check evaluates whether an alert should be generated based on the log level of the log entry when it is raised. There are three types of log level based on the risk/severity of the log, namely info, warning, and error. For each trigger you can specify the log level, you can also combine levels for example, warning and error levels.
47	47
48	48	[[image:Main.Images.Microlearning.WebHome@novice-alerting-error-alerts-evaluate-exception-class.png]]
49	49
50		-If you set it to "Ignore", then the exception class will not be evaluated when determining whether an alert should be raised. If set to "By Condition", then you can specify what exception class to evaluate and define conditions such as whether it equals, does not equal, contains, or does not contain a specific value to result in an alert.
	49	+=== 3.3 Runtime check ===
51	51
52		-=== 3.3 Evaluate exception message ===
	51	+This check evaluates whether an alert should be generated when an log entry is raised from which runtime in the environment.
53	53
54		-This check evaluates whether an alert should be generated based on both the first and last exception message of the error message when it is raised.
55		-
56		-[[image:Main.Images.Microlearning.WebHome@novice-alerting-error-alerts-evaluate-exception-message.png]]
57		-
58		-If you set it to "Ignore", then the exception message will not be evaluated when determining whether an alert should be raised. If set to "By Condition," then you can specify a string to check in both the first and last exception messages, and define conditions like equals, not equals, contains, or does not contain to result in an alert.
59		-
60		-=== 3.4 Runtime check ===
61		-
62		-This check evaluates whether an alert should be generated when an error message is raised from which runtime in the environment.
63		-
64	64	[[image:Main.Images.Microlearning.WebHome@novice-alerting-error-alerts-runtime-check.png]]
65	65
66		-If you set it to "Ignore", then which runtime where the error occured will not be evaluated when determining whether an alert should be raised. If set to "By Condition", then you can specify which runtime where the error message occured to result in an alert.
	55	+If you set it to "Ignore", then which runtime where the error occured will not be evaluated when determining whether an alert should be raised. If set to "By Condition", then you can specify which runtime where the log entry occured to result in an alert.
67	67
68	68	=== 3.5 Instruction ===
69	69
...	...	@@ -71,12 +71,12 @@
71	71
72	72	[[image:Main.Images.Microlearning.WebHome@novice-alerting-error-alerts-instructions.png]]
73	73
74		-Lastly, upon saving, these settings will apply immediately, putting the new error alert trigger into effect. Next to that, 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 error 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"]].
	63	+Lastly, upon saving, these settings will apply immediately, putting the new log alert trigger into effect. Next to that, 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 error 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"]].
75	75
76	76	== 4. Key takeaways ==
77	77
78		-* eMagiz allows users to create and customize error alerts by defining triggers that will raise alerts and send notifications when error messages with specific conditions occur.
79		-* eMagiz provides four checks for error alerts: message header, exception class, exception message, and runtime. These checks can be configured to evaluate conditions such as "equals," "not equals," "contains," or "does not contain" to determine if an alert should be triggered.
	67	+* eMagiz allows users to create and customize log alerts by defining triggers that will raise alerts and send notifications when error messages with specific conditions occur.
	68	+* eMagiz provides three checks for log alerts: log message, log level, and runtime. These checks can be configured to evaluate conditions such as "equals," "not equals," "contains," or "does not contain" to determine if an alert should be triggered.
80	80	* Alerts are generated only if all specified checks in a trigger are met. Users can also configure recipients for error alert notifications, ensuring messages reach the appropriate stakeholders.
81	81
82	82	== 5. Suggested Additional Readings ==