+
+

Using Flex Gateway API Alerts

Using API alerts for Flex Gateway in Connected Mode, you can add and configure email notifications that flag unusual API behavior, such as:

  • An API response time over 60 seconds

  • More than 1000 API requests in 30 seconds

See Add API Alerts below.

Types of API Alerts

Add any of the following alerts to notify you of the condition described:

  • Total Request Count: Users request access to the API more times than allowed during a specified time. Specify time interval values from 1 through 999999999. To prevent data bursts, intervals are implemented as sliding windows instead of as absolute minute boundaries. See Sliding Windows.

  • Average Response Time: The response time of the API exceeds a specified timeout period.

  • Response Codes: Upon receiving a request, the API returns an HTTP code of 400, 401, 403, 404, 408, 500, 502, or 503 or a custom three-digit response.

  • Policy Violation: An infraction of a specified policy governing the API occurs.

How API Alerts Work

API alerts are triggered only when:

  • The API state changes

    Note that the first occurrence of a state change might go undetected if a newly created alert does not include defined states.

  • The alert conditions are met for the specified period of time

    For example, if an alert is configured to trigger when an API returns an HTTP code of 500 five or more times within a 10-minute period, it does not trigger if the API returns a code of 500 only once within that 10-minute period.

When configuring an API alert, you can select business group users and users outside your organization to receive email notifications about the alert. Notifications include information about events that trigger alerts as specified by severity level.

API Alerts are sent from no-reply@mulesoft.com. This cannot be customized.
  • The first email describes the alert:

    Your API, CesarDemoAPI - Basic:151 (Environment: "NewOne"), has received greater than 2 requests within 1 consecutive periods of 1 minutes.

  • Another email notifies you when the alert is resolved:

    Your API Version, jsonplaceholderapi - 1.0.development, is no longer in an alert state. The number of policy violations was not greater than 1 in the last 1 consecutive periods of 1 minutes.

After the first set of two notification emails is sent, API Manager stops listening for alerts until the next alert period begins. This technique prevents repeated notification emails.

Before You Begin

To view and delete alerts, ensure that you have:

  • Manage Alerts permission to view and delete API alerts.

  • View Alerts permission for view-only access to alerts.

Add API Alerts

To track and manage APIs, you can add one or more API alerts to your API instances. Add different types of alerts based on your requirements.

Users can have six to ten active alerts. Pausing or deleting an alert allows you to create new alerts once you have reached the maximum number of alerts.

The maximum number of alerts you can create per API instance depends on your plan. Organizations that have a Gold or Platinum subscription can have up to six active alerts per API instance. Organizations that have a Titanium subscription can have up to ten active alerts per API instance. With all plans, deleting or pausing alerts allows you to create new ones.

Alerts cannot be added to API instances protected by automated policies.

Alerts are enabled by default when they are created. This setting cannot be modified.

To add an API alert:

  1. Navigate to API Manager > API Administration and click the API instance for which you want to add an alert.

  2. From the left navigation pane, select Alerts > New alert.

  3. Specify values for the displayed alert options:

    • Name:

      Type an alert name, for example trial-alert. You can delete an alert anytime if not required.

    • Severity:

      Select a severity for the alert:

      • Info

        Assign to alerts that do not require immediate attention when triggered. This severity indicates that the metric should be passively monitored.

      • Warning

        Assign to alerts that require prompt attention when triggered. This severity indicates an alert should be closely monitored.

      • Critical

        Assign to alerts that require immediate attention when triggered. This severity indicates an alert should receive an immediate response.

  4. Specify the alert conditions:

    • Metric

      Condition that triggers the alert.

    • Logic

      When the alert is triggered, based on the occurrence rate defined in the When number of occurrences are and For at least [number of] minutes fields.

  5. Configure the email notification:

    • Subject

      Subject of the alert email to send when the alert is triggered. The subject can include variables. See Variable Definitions.

    • Message

      Body text for the email to send when the alert is triggered. The message body can include variables. See Variable Definitions.

    • Recipients

      Recipients of the alert email. You can select up to 20 platform user IDs and enter up to 20 email addresses.

  6. Click Create.

Alerts appear as Pending when they are created. After the API receives traffic, the alert changes to a state of OK. Depending on the value, the alert transitions to OK or Alerting.

Alert Email Template

You can use the following variables in the Subject and Message fields for basic email alerts.

For the description of each variable, see Variable Definitions.

Table 1. Variables for Alerts
Alert Applicable Variables

Total Request Count

  • ${severity}

  • ${operator}

  • ${threshold}

  • ${period}

  • ${value}

  • ${condition}

  • ${organization}

  • ${environment}

  • ${apiLink}

  • ${dashboardLink}

  • ${api}

  • ${policy}

Average Response Time

Response Codes

Policy Violations

Table 2. Variable Definitions
Variable Definition

${apiLink}

URL of the triggered API

${alertState}

State of the alert when it was triggered.

Available values are OK or Alerting.

${comparison}

* Above, above or equal, equal, below or equal, below

${condition}

Metric for which the alert is triggered

${environment}

Name of the environment in which the resource is deployed

${operator}

An operator, such as < > =

${organization}

Name of the organization that owns the alert

${period}

Period of time over which to measure

${severity}

Severity of the alert

${threshold}

Count over the period of time that triggers the alert

${value}

Value of the metric that triggers the alert

Pause and Edit API Alerts

Pausing an alert causes the alert to transition to Paused.

You can also edit an existing alert by following these steps:

  1. In API Manager, click API Administration in the left navigation bar.

  2. Click the API instance and version that you want to edit and then click Alerts.

  3. Click Edit from the three-dots menu (5%) on the alert you want to edit.

    Edit alerts

Test API Alerts

The process for testing API alerts begins with creating a Flex Gateway. Follow these steps to get started with Flex Gateway and test alerts:

View and Delete Alerts

To view and delete alerts:

  1. From API Manager, click API Administration > API instance, and select Alerts.

    Viewing and adding alerts
  2. Expand an alert in the list.

    Details about the alert options appear.

  3. Click Delete from the three-dots menu (5%) on the alert you want to delete. You can also delete an alert when editing it.

Was this article helpful?

💙 Thanks for your feedback!

Submit your feedback!
Share your thoughts to help us build the best documentation experience for you!
Take our latest survey!