Skip to content

Commit fd65b79

Browse files
policy violations
1 parent 50e7bd3 commit fd65b79

1 file changed

Lines changed: 13 additions & 9 deletions

File tree

modules/ROOT/pages/add-api-alert-task.adoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ ifndef::env-site,env-github[]
33
include::_attributes.adoc[]
44
endif::[]
55

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

810
See the following steps to add API alerts for your runtime:
911

@@ -12,15 +14,15 @@ See the following steps to add API alerts for your runtime:
1214
1315
[NOTE]
1416
====
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].
1618
====
1719

1820
[[mule-gateway]]
1921
== Add API Alerts for Mule Gateway or Service Mesh>
2022
To add an API alert to a Mule Gateway or Service Mesh API:
2123

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*.
2426
. Specify the alert options:
2527
* *Name*:
2628
+
@@ -35,7 +37,7 @@ You can delete an alert anytime if not required.
3537
Select a severity for the alert, for example, *Info*.
3638
* *Alert type*:
3739
+
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]
3941
+
4042
[TIP]
4143
====
@@ -49,9 +51,9 @@ In the *For at least* and *consecutive period(s) of* fields, enter a value in th
4951
== Add API Alerts for Flex Gateway
5052
To add an API alert to a Flex Gateway API:
5153

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

54-
. From the left navigation pane, select *Alerts* > *New alert*.
56+
. From the left navigation panel, select *Alerts* > *New alert*.
5557

5658
. Specify the alert options:
5759

@@ -65,11 +67,13 @@ Select a severity for the alert, for example, *Info*.
6567

6668
* *Metric*
6769
+
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].
6971

7072
* *Logic*
7173
+
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.
7377

7478
. Specify the email notification:
7579

0 commit comments

Comments
 (0)