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
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,9 @@ 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. Adding alerts is the same for API Instances using Mule Gateway or Service Mesh as their runtime, but adding alert for APIs using Flex Gateway as there runtime is different.
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.
7
9
8
10
See the following steps to add API alerts for your runtime:
9
11
@@ -12,15 +14,15 @@ See the following steps to add API alerts for your runtime:
12
14
13
15
[NOTE]
14
16
====
15
-
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].
16
18
====
17
19
18
20
[[mule-gateway]]
19
21
== Add API Alerts for Mule Gateway or Service Mesh>
20
22
To add an API alert to a Mule Gateway or Service Mesh API:
21
23
22
-
. Navigate to *API Manager* > *API Administration* and click the Mule API instance for which you want to add an alert.
23
-
. 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, select *Alerts* > *Add alert*.
24
26
. Specify the alert options:
25
27
* *Name*:
26
28
+
@@ -35,7 +37,7 @@ You can delete an alert anytime if not required.
35
37
Select a severity for the alert, for example, *Info*.
36
38
* *Alert type*:
37
39
+
38
-
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]
39
41
+
40
42
[TIP]
41
43
====
@@ -49,9 +51,9 @@ In the *For at least* and *consecutive period(s) of* fields, enter a value in th
49
51
== Add API Alerts for Flex Gateway
50
52
To add an API alert to a Flex Gateway API:
51
53
52
-
. Navigate to *API Manager* > *API Administration* and click the Mule API instance for which you want to add an alert.
54
+
. Navigate to *API Manager* > *API Administration* and click the API instance for which you want to add an alert.
53
55
54
-
. From the left navigation pane, select *Alerts* > *New alert*.
56
+
. From the left navigation panel, select *Alerts* > *New alert*.
55
57
56
58
. Specify the alert options:
57
59
@@ -65,11 +67,13 @@ Select a severity for the alert, for example, *Info*.
65
67
66
68
* *Metric*
67
69
+
68
-
Select a metric for the alert, for example, *Policy Violation*. For information about metric types, see xref:using-api-alerts.adoc#api-alerts[API Alerts].
70
+
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].
69
71
70
72
* *Logic*
71
73
+
72
-
Specify the logic of when to alerts, for example, when total policy violations is *above* *0* for at least *5* minutes.
74
+
Specify the logic of when to alert, for example, when total policy violations is *above* *0* for at least *5* minutes.
75
+
+
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.
0 commit comments