You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/add-api-alert-task.adoc
+20-17Lines changed: 20 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,11 +18,11 @@ You cannot add Policy Violation alerts to xref:automated-policies-landing-page.a
18
18
====
19
19
20
20
[[mule-gateway]]
21
-
== Add API Alerts for Mule Gateway or Service Mesh>
21
+
== Add API Alerts for Mule Gateway or Service Mesh
22
22
To add an API alert to a Mule Gateway or Service Mesh API:
23
23
24
-
. Navigate to *API Manager* > *API Administration* and click the API instance for which you want to add an alert.
25
-
. From the left navigation panel, select *Alerts* > *Add alert*.
24
+
. Navigate to *API Manager > API Administration* and click the API instance for which you want to add an alert.
25
+
. From the left navigation panel, click *Alerts > Add alert*.
26
26
. Specify the alert options:
27
27
* *Name*:
28
28
+
@@ -37,23 +37,26 @@ You can delete an alert anytime if not required.
37
37
Select a severity for the alert, for example, *Info*.
38
38
* *Alert type*:
39
39
+
40
-
Select the type of alert to create, (for example, *Request Count*) and provide appropriate alert configuration values. For information about alert types, see xref:using-api-alerts.adoc#api-alerts[API Alerts]
40
+
Select the type of alert to create, (for example, *Request Count*) and provide appropriate alert configuration values. For information about alert types, see xref:using-api-alerts.adoc#api-alerts[API Alerts].
41
41
+
42
42
[TIP]
43
43
====
44
44
In the *For at least* and *consecutive period(s) of* fields, enter a value in the range of 1 - 999999999 to specify the time interval as a https://www.techopedia.com/definition/869/sliding-window[sliding window^].
45
45
====
46
46
47
47
. Select *Recipients*.
48
-
. Select *Create Alert*.
48
+
+
49
+
Specify what emails receive the email notification.
50
+
51
+
. Click *Create Alert*.
49
52
50
53
[[flex-gateway]]
51
54
== Add API Alerts for Flex Gateway
52
55
To add an API alert to a Flex Gateway API:
53
56
54
-
. Navigate to *API Manager* > *API Administration* and click the API instance for which you want to add an alert.
57
+
. Navigate to *API Manager > API Administration* and click the API instance for which you want to add an alert.
55
58
56
-
. From the left navigation panel, select *Alerts* > *New alert*.
59
+
. From the left navigation panel, click *Alerts > New alert*.
57
60
58
61
. Specify the alert options:
59
62
@@ -65,31 +68,31 @@ Type an alert name, for example `trial-alert`.
65
68
+
66
69
Select a severity for the alert, for example, *Info*.
67
70
68
-
* *Metric*
71
+
* *Metric*:
69
72
+
70
73
Select a metric for the alert, for example, *Policy Violation*. For information about metric or alert types, see xref:using-api-alerts.adoc#api-alerts[API Alerts].
71
74
72
-
* *Logic*
75
+
* *Logic*:
73
76
+
74
77
Specify the logic of when to alert, for example, when total policy violations is *above* *0* for at least *5* minutes.
75
78
+
76
-
If you select *Policy Violation* or *Response Code*, first specify the policy or response code to monitor. Then, specify the logic of when to alert.
79
+
If you selected *Policy Violation* or *Response Code* as your metric type, first specify the policy or response code to monitor. Then, specify the logic of when to alert.
77
80
78
-
. Specify the email notification:
81
+
. Configure the email notification:
79
82
80
-
* *Subject*
83
+
* *Subject*:
81
84
+
82
85
Type the subject of the email. The default is the alerts severity, API name, and API condition.
83
86
84
-
* *Message*
87
+
* *Message*:
85
88
+
86
-
Type the message of the email. The default message explains why you are receiving the API alert and provids links to the API.
89
+
Type the message of the email. The default message explains why you are receiving the API alert and provids links to the API and environment.
87
90
88
-
* *Recipients*
91
+
* *Recipients*:
89
92
+
90
-
Specify what emails recieve the email notification.
93
+
Specify what emails receive the email notification.
0 commit comments