add-api-alert-task.adoc

Add Instance Alerts in API Manager (Mule Gateway or Service Mesh)

Instance alerts in API Manager email recipients when request volume, response codes, response times, or other conditions cross thresholds you set for an API instance on Mule Gateway or Anypoint Service Mesh. You name each alert, set severity, choose from alert types, configure time ranges as sliding windows, and specify email recipients. Policy Violation alerts are unavailable for automated policies, and Omni Gateway instances use a separate alert workflow.

Note	This task applies to Mule Gateway and Anypoint Service Mesh runtimes only. To add alerts to instances that use Omni Gateway as their runtime, see Add Instance Alerts for Omni Gateway.

Configure an Instance Alert

To add an alert to a Mule Gateway or Anypoint Service Mesh instance:

1. Navigate to Anypoint Platform > API Manager.

2. In API Administration, click the instance to which to add an alert.

3. Click Alerts > Add alert.

4. Specify the alert options:

   • Name:

     Type an alert name, for example trial-alert.

     If adding multiple alerts to the same environment, the alerts must have unique names.

   • Enabled:

     The default option is Enabled.

     You can delete an alert anytime if not required.

   • Severity:

     Select a severity for the alert, for example, Info.

   • Alert type:

     Select the type of alert to create, (for example, Request Count) and provide appropriate alert configuration values. For information about alert types, see Instance Alerts.

     Tip	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 sliding window.

5. Select Recipients.

   Specify which email addresses receive the email notification.

6. Click Create Alert.

See Also

• Review Alerts Concepts

• gateway::flex-use-api-alerts.adoc