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
+64-7Lines changed: 64 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,17 +3,26 @@ ifndef::env-site,env-github[]
3
3
include::_attributes.adoc[]
4
4
endif::[]
5
5
6
-
To track and manage APIs, you can add one or more API alerts to your API instances. Add different xref:using-api-alerts.adoc[types of alerts] based on your requirements.
6
+
To track and manage APIs, you can add one or more API alerts to your API instances. Add different xref:using-api-alerts.adoc[types of alerts] based on your requirements.
7
+
8
+
For APIs using Mule Gateway or Service Mesh as their runtime, adding alerts follows the same steps. For APIs using Flex Gateway as their runtime, there are different steps.
9
+
10
+
See the following steps to add API alerts for your runtime:
11
+
12
+
* <<mule-gateway, Add API Alerts for Mule Gateway or Service Mesh>>
13
+
* <<flex-gateway, Add API Alerts for Flex Gateway>>
7
14
8
15
[NOTE]
9
16
====
10
-
Alerts cannot be added to API instances protected by xref:automated-policies-landing-page.adoc[automated policies].
17
+
You cannot add Policy Violation alerts to xref:automated-policies-landing-page.adoc[automated policies].
11
18
====
12
19
13
-
To add an API alert:
20
+
[[mule-gateway]]
21
+
== Add API Alerts for Mule Gateway or Service Mesh
22
+
To add an API alert to a Mule Gateway or Service Mesh API:
14
23
15
-
. Navigate to *API Manager* > *API Administration* and click the API instance for which you want to add an alert.
16
-
. From the left navigation pane, 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*.
17
26
. Specify the alert options:
18
27
* *Name*:
19
28
+
@@ -28,15 +37,63 @@ You can delete an alert anytime if not required.
28
37
Select a severity for the alert, for example, *Info*.
29
38
* *Alert type*:
30
39
+
31
-
Select the type of alert to create, (for example, *Request Count*) and provide appropriate alert configuration values.
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].
32
41
+
33
42
[TIP]
34
43
====
35
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^].
36
45
====
37
46
38
47
. Select *Recipients*.
39
-
. Select *Create Alert*.
48
+
+
49
+
Specify what emails receive the email notification.
50
+
51
+
. Click *Create Alert*.
52
+
53
+
[[flex-gateway]]
54
+
== Add API Alerts for Flex Gateway
55
+
To add an API alert to a Flex Gateway API:
56
+
57
+
. Navigate to *API Manager > API Administration* and click the API instance for which you want to add an alert.
58
+
59
+
. From the left navigation panel, click *Alerts > New alert*.
60
+
61
+
. Specify the alert options:
62
+
63
+
* *Alert Name*:
64
+
+
65
+
Type an alert name, for example `trial-alert`.
66
+
67
+
* *Severity*:
68
+
+
69
+
Select a severity for the alert, for example, *Info*.
70
+
71
+
* *Metric*:
72
+
+
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].
74
+
75
+
* *Logic*:
76
+
+
77
+
Specify the logic of when to alert, for example, when total policy violations is *above* *0* for at least *5* minutes.
78
+
+
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.
80
+
81
+
. Configure the email notification:
82
+
83
+
* *Subject*:
84
+
+
85
+
Type the subject of the email. The default is the alerts severity, API name, and API condition.
86
+
87
+
* *Message*:
88
+
+
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.
90
+
91
+
* *Recipients*:
92
+
+
93
+
Specify what emails receive the email notification.
0 commit comments