|
1 | | -= Add API Alerts |
| 1 | += Add API Alerts for Mule Gateway or Service Mesh |
2 | 2 | ifndef::env-site,env-github[] |
3 | 3 | include::_attributes.adoc[] |
4 | 4 | endif::[] |
5 | 5 |
|
6 | 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 | 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. |
| 8 | +For APIs using Mule Gateway or Service Mesh as their runtime, follow the steps in this tutorial to add alerts to your APIs. |
9 | 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>> |
14 | | -
|
15 | | -[NOTE] |
16 | | -==== |
17 | 10 | You cannot add Policy Violation alerts to xref:automated-policies-landing-page.adoc[automated policies]. |
18 | | -==== |
| 11 | + |
| 12 | +NOTE: This tutorial is on for Mule Gateway or Service Mesh runtimes. To add alerts to APIs using Flex Gateway as their runtime, see xref:gateway::flex-use-api-alerts.adoc[Add API Alerts for Flex Gateway]. |
19 | 13 |
|
20 | 14 | [[mule-gateway]] |
21 | 15 | == Add API Alerts for Mule Gateway or Service Mesh |
@@ -50,51 +44,8 @@ Specify what emails receive the email notification. |
50 | 44 |
|
51 | 45 | . Click *Create Alert*. |
52 | 46 |
|
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. |
94 | | - |
95 | | -. Click *Create Alert*. |
96 | | - |
97 | 47 |
|
98 | 48 | == See Also |
99 | 49 |
|
100 | 50 | * xref:using-api-alerts.adoc[Review Alerts Concepts] |
| 51 | +* xref:gateway::flex-use-api-alerts.adoc[Add API Alerts for Flex Gateway] |
0 commit comments