Loading

Changes to the API Alerts | API Key Metrics Charts | API Analytics in Anypoint API Manager

Data pubblicazione: Sep 5, 2025
Descrizione

Overview

To support monitoring, analytics, and troubleshooting needs of enterprise customers, the API Manager alerting and metrics experience is transitioning to the modern technology stack that supports Anypoint Monitoring. The new experience will be simple and powered by robust and reliable technology. This document talks about the impact and changes required in API Alerts, API Key Metrics Charts and API Analytics for Mule APIs.

* New Customer is onboarded with Alert, Analytics and Key metrics powered by Anypoint Monitoring automatically

 

Features in API Manager 

For Mule APIs * Existing Customer

For Flex APIs 

API Alert 

Introducing New Experience

No Changes to Existing Experience 

API Key Metrics 

Introducing New Experience 

No Changes to Existing Experience 

API Analytics 

Introducing New Experience by replacing existing analytics experience with Anypoint Monitoring 

Not Applicable

 

This transition impacts API Manager and its underlying APIs in these ways:

Risoluzione

API Alerts

The API Alerts change has been postponed until further notice. It is strongly recommended to migrate alerts from API Manager to Anypoint Monitoring to leverage the modern technology stack for alerts. 

 

Impacts of this change:
API alerts in API Manager that you want to keep must be recreated in Anypoint Monitoring. 

We encourage all customers to recreate alerts themselves. Once alerts are created, please delete the stale alerts. For additional information, please see section Differences between Anypoint Monitoring and API Manager

 

For guidance with this change, see Create or Migrate API alerts to Anypoint Monitoring.

Create or Migrate API Alerts to Anypoint Monitoring

API alerts created from the legacy technology stack will no longer be supported. However, API Manager will still have an alerting experience, and new basic API alerts in Anypoint Monitoring will also appear in API Manager. The Anypoint Monitoring agent is required to evaluate metrics and migrate API alerts successfully. 

 

  • API Alerts Comparisons

  • Add API alerts to Anypoint Monitoring

 

After the migration takes place, the UI for the Mule API alerts experience in API Manager will match the Flex Gateway alerting experience in API Manager. 

Differences between Anypoint Monitoring and API Manager

  • Alert evaluation: Anypoint Monitoring evaluates API alerts every minute using a configurable 5-20 minute lookback window, while API Manager allows an arbitrary lookback window.

  • Alert limits: Anypoint Monitoring limits the number of API alerts based on the subscription tier. For comparison, see API Alert Limits (for API Manager) and Anypoint Monitoring alert limits. 

Add API Alerts to Anypoint Monitoring

If you have API Alerts in API Manager, you can transition to the alerting system that supports Anypoint Monitoring in one of these ways:

  • Replicate API alerts from the Anypoint Platform UI

  • Prepare for Automated Migration of API alerts

 

Important! API alerts created in Anypoint Monitoring before the automated migration from API Manager will appear in both Anypoint Monitoring and API Manager around the same time that the automated API alerts migration to Anypoint Monitoring occurs.

Create API alerts from the Anypoint Monitoring UI

To replicate your API Manager API alerts in Anypoint Monitoring: 

  1. If you intend to use API alerts, make sure that the Anypoint Monitoring agent is enabled for CloudHub deployments or installed for Hybrid deployments. For guidance, see section Set Up the Anypoint Monitoring Agent. 

  2. Delete any inactive or disabled API alerts from API Manager. For guidance, see Viewing and Deleting API Alerts in the API Manager documentation.

  3. Follow the steps in Setting Up Basic API alerts in Anypoint Monitoring to replicate your API alerts in Anypoint Monitoring.

  4. Disable the API Manager API alerts that you recreated in Anypoint Monitoring.
    Disabling these alerts is very important. Disabling API alerts prevents duplicate notifications and prevents  automated migration of the enabled API alert to Anypoint Monitoring.

  5. Start using Anypoint Monitoring for your API alerts.

Prepare for Automated Migration of API alerts

Once the manual alert migration period expires, enabled API alerts remaining in API Manager will be automatically migrated to Anypoint Monitoring. These API alerts will appear in both API Manager and Anypoint Monitoring. 

 

Alert configuration parameters in the API Manager UI are more broad than those in Anypoint Monitoring. For this reason, the migrator must adjust API alerts configurations for enabled API alerts that do not conform to Anypoint Monitoring limits. For details, see API alerts Migration Algorithm

  1. If you have API alerts to migrate automatically, make sure that the Anypoint Monitoring agent is enabled for CloudHub deployments or installed for Hybrid deployments. For guidance, see Set Up the Anypoint Monitoring Agent.

  2. Make sure that the API Manager API alerts you want to migrate automatically are enabled. For guidance, see Editing, Enabling, or Disabling API Alerts in the API Manager documentation.
    Editing, Enabling, or Disabling API Alerts | MuleSoft Documentation

  3. If you have API Manager alert configurations that are not supported by Anypoint Monitoring API alerts, follow either of these guidelines:

    • Allow the migrator to adjust alert configurations according to the migration algorithm.

    • Reconfigure your API Manager alert in accordance with Anypoint Monitoring limits. 


Alternatively, you can manually recreate the alert in Anypoint Monitoring and disable the alert in API Manager prior to the migration. 

 

Old Experience for Mule API Alerts (Inside API Manager)

 

New Experience (Inside API Manager)

 

API Key Metrics Charts

To retain access to the Mule API Key Metrics charts under API Summary in API Manager, you must enable or install Anypoint Monitoring agent. Failure to install this agent causes you to lose access to Key Metrics charts. The last date to install Anypoint Monitoring Agent is June 02, 2025.

This requirement applies to CloudHub and Hybrid deployments. For Flex Gateway and CloudHub 2.0 deployments, no changes are necessary. For guidance with this change, see Mule Key Metrics in API Manager.

Set Up the Anypoint Monitoring Agent

Evaluation of metrics configured in API alerts and the automated migration of API alerts require the Anypoint Monitoring agent. The agent is already enabled for CloudHub 2.0 and Flex Gateway deployments. However, if you intend to create or migrate API alerts for Cloudhub or Hybrid deployments and if the Anypoint Monitoring agent is not yet enabled for Cloudhub deployments or installed for Hybrid deployments, you must take this action:

 

  1. If you have API alerts in API Manager for a CloudHub (not CloudHub 2.0) deployment, you must enable the Anypoint Monitoring agent. If the agent is already enabled, no action is required.
    For guidance, see Enable Anypoint Monitoring for your Mule Apps. See Setting Up Monitoring for CloudHub Deployments.

  2. If you have API alerts in API Manager for a Hybrid deployment, you must install the Anypoint Monitoring agent. If the agent is already installed, no action is required.
    For guidance, see Setting Up Monitoring for Hybrid Deployments. 

 

Mule API Key Metrics in API Manager

The only metrics available in API Manager are API Key Metrics. For CloudHub (not CloudHub 2.0) and hybrid deployments of Mule apps, Key Metrics in API Manager require installation of the Anypoint Monitoring agent. For Flex Gateway and CloudHub 2.0, no changes are necessary.

 

Key Metrics:

  • Total Requests

  • Total Policy Violations

  • Total Errors

  • Average Response Time

 

For guidance, see Access Key Metrics through the Anypoint Monitoring Agent and the knowledge article Legacy API Manager Mule API Analytics | Key Metrics Charts Experience End of Life.

 

Old experience for Mule API Key metrics (Inside API Manager)

 

New experience for Mule API Key metrics (Inside API Manager)

 

Mule API Analytics

Anypoint Monitoring dashboards will replace Mule API Analytics dashboards in API Manager. The API Analytics changes will be implemented on June 02, 2025.


Impacts of this change: 

  • To view metrics on your Mule apps and APIs, transition to Anypoint Monitoring dashboards.

  • The Analytics Event Export API will no longer be available for querying and extracting raw event data from API Manager analytics reports.
    Anypoint Monitoring Archive API,Anypoint Monitoring Metrics API, and Mule API Analytics event forwarding serve as replacements for the Analytics Event Export API.

For guidance with this transition, see Use Anypoint Monitoring and Supported APIs.

Use Anypoint Monitoring and Supported APIs for Metrics

Anypoint Monitoring dashboards replace Mule API Analytics dashboards in API Manager. Alternatives to the API Analytics Event API for API Manager are also available.

  • Use Anypoint Monitoring and Anypoint Platform UIs

  • Use Anypoint Monitoring APIs

Use Anypoint Monitoring and Anypoint Platform UIs

Use Anypoint Insights and custom dashboards in Anypoint Monitoring as the primary alternatives to the Mule API Analytics dashboard in API Manager. To use Anypoint Monitoring, see the Anypoint Monitoring documentation:

 

To export or forward your Mule API Analytics events data without relying on Mule API Analytics features, you can also use:

Use Anypoint Monitoring APIs

The Mule API Analytics Event API for API Manager will no longer be available for querying and extracting raw event data from API Manager charts. This is effective from June 02,2025.

When you transition to dashboards in Anypoint Monitoring, you can also use its APIs. 

 

API To Be Discontinued

Replacement APIs and Anypoint Platform UIs

Analytics Events Export API (sometimes called API Analytics Events Export API)

  • Supports exports of API-related event data from API Manager

  • Captures requests, responses, and outcomes individually and does not aggregate data on these events

  • Provides data over a 30-day period

  • Extracts the raw event data captured by the Mule API gateway

Anypoint Monitoring Metrics API
(available to all subscription tiers, requires login to Anypoint Platform):

  • Provides access metrics that Anypoint Insights exposes. 

  • Uses the Anypoint Monitoring Query Language (AMQL) to construct flexible and secure queries to access metrics data.


Anypoint Monitoring Archive API
(available to the Titanium tier only):

  • Exports monitoring events for specific API and Mule app deployments 

  • Aggregates returned event data in 1-minute intervals

  • Limits availability to the Titanium (core-based) and the Advanced (usage-based) subscription tiers

  • Provides data over a 90-day period

 

The Metrics and Archive APIs support many important fields available to API Events Export API but do not yet support others. See Appendix: API Field Comparisons.

Appendix

API Field Comparisons

Most fields in the Analytics Events Export API for API Manager are available in the Anypoint Monitoring Metrics API and Anypoint Monitoring Archive API. Some Archive API fields are enabled with a raw data property described in the Anypoint Monitoring documentation.

 

Analytics Events Export API
(to be discontinued)

Anypoint Monitoring Metrics API

Anypoint Monitoring Archive API 

Client IP

"events"."remote_host"

"events"."remote_host"

API ID

"commons"."api_id"

"commons"."api_id"

API Name

"events"."api_name"

"events"."api_name"

API Version ID

"events"."api_version_id" or "commons"."api_version_id"

"events"."api_version_id" or "commons"."api_version_id"

API Version Name

"events"."api_version"

"events"."api_version"

Runtime Host

"commons"."public_ip"

"commons"."public_ip"

Application

"events"."client_id"

"events"."client_id"

Application Name

Not available

"events"."client_app"
(note: raw data field)

Message ID

Not available

Not available

Timestamp

"time"

"events"."_time"

Request Size

"events"."request_size.min
|request_size.max
|request_size.count"

"events"."request_size"

Response Size

"events"."response_size.min
|response_size.max
|response_size.count"

"events"."response_size"

Request Outcome

"events"."request_disposition"

"events"."request_disposition"

Verb

"events"."method"

"events"."method"

Resource Path

"events"."path"

"events"."path"

Status Code

"events"."status_code"

"events"."status_code"

User Agent Name

Not available

"events"."user_agent"
 (note: raw data field)

User Agent Version

Not available

Browser

Not available

Not available

OS Family

Not available

Not available

OS Version

Not available

Not available

OS Major Version

Not available

Not available

OS Minor Version

Not available

Not available

Hardware Platform

Not available

Not available

Timezone

Not available

Not available

City

Not available

Not available

Country

"events"."country"

"events"."country"

Continent

Not available

Not available

Postal Code

Not available

Not available

Violated Policy Name

"events"."policy_name"

"events"."policy_name"

Response Time

"events"."response_time.min
|response_time.max
|response_time.count"

"events"."response_time"

Not available

Not available

"events"."api_instance_label"
 (note: raw data field)

Not available

"events"."flow_id"

"events"."flow_id"

Not available

"commons"."app_id

"commons"."app_id

 

API Alerts Migration Algorithm 

API alerts in API Manager and Anypoint Monitoring have different limits. To migrate enabled API Manager alert configurations to Anypoint Monitoring, it's necessary to conform configurations with Anypoint Monitoring limits. 

 

Recommendation: To avoid configuration outcomes produced by the migrator, you can manually migrate your API alerts to Anypoint Monitoring, or you can reconfigure your alerts in API Manager prior to the automatic migration in a way that produces a more preferable outcome.

 

Anypoint Monitoring aggregates data into periods of 5, 10, 15, or 20 minutes for alert notifications, while API Manager allows for aggregation by any number of minutes, hours, or days. 

 

API Manager Alert Configuration

Anypoint Monitoring Alert Configuration

Configurations for triggering an alert can be broader than Anypoint Monitoring allows:


The period settings are flexible: You can set any number of consecutive periods (days, hours, or minutes) over which the event is evaluated.

Example:
2 consecutive 4-hour periods 

Configurations for triggering an alert are more limited than API Manager allows:

Only one-minute periods are allowed for a fixed number of consecutive occurrences: You can select 5, 10, 15, or 20 consecutive periods of 1 minute each over which events are evaluated.

Example:
2 consecutive minutes

 

The migrator uses an algorithm that adjusts the alert configuration to Anypoint Monitoring data aggregation limits:

 

Evaluation Period

Consecutive Period Configuration

Adjustment for Anypoint Monitoring Alert

1 minute

Number of consecutive periods
equals (=) 5, 10, 15, or 20

No adjustment is needed. The new Anypoint Monitoring alert matches the API Manager alert configuration.

Number of consecutive periods
is not equal to (≠) 5, 10,  15, or 20 

The migrator sets the number of consecutive periods to the nearest multiple of 5, 10, 15, or 20.


For example, if the number is set to 11 in the API Manager, the migrator sets the number to 10 in Anypoint Monitoring.

> 1 minute

Number of consecutive periods
equals (=) 5, 10, 15, or 20

The migrator changes the configured number occurrences for the alert condition to the nearest integer approximating
(number of times the condition is met)➗(evaluation duration).

See Example 1.

Number of consecutive periods
is not equal to (≠) 5, 10,  15, or 20 

The migrator changes the configured number occurrences for the alert condition to the nearest integer approximating 
(number of times the condition is met)➗(evaluation duration).

The migrator also adjusts the number of consecutive periods to the value of the nearest supported period (5, 10, 15, or 20).

See Example 2.



Examples of API Alert Migration with Evaluation Periods Over 1 Minute

For alerts in API Manager that have evaluation periods greater than (>) 1 minute, the migrator's behavior depends on the number of consecutive evaluation periods configured for the alert. 

 

Example 1: For evaluation periods over 1 minute and a number consecutive periods is equal to (=) 5, 10, 15, or 20 

  • Assume the API alert in API Manager has this configuration:
    100 occurrences of the alert condition for 10 consecutive periods of 5 minutes

The migrator converts the API alert settings to 20/10, which results in this configuration for the alert in Anypoint Monitoring:

  • 20 occurrences of alert condition 

  • 10 consecutive periods of 1 minute each

 

  • Assume the API alert in API Manager has this configuration:
    100 occurrences of the alert condition for 10 consecutive periods of 11 minutes
    The migrator converts these settings to 100/11 (= ~9) , which results in this configuration for the alert in Anypoint Monitoring:

  • 9 occurrences of alert condition 

  • 10 consecutive periods of 1 minute each

 

Example 2: For evaluation periods over 1 minute and the number consecutive periods is not equal to (≠) 5, 10, 15, or 20

  • Assume the API alert in API Manager has this configuration:
    100 occurrences of the alert condition for 11 consecutive periods of 5 minutes

The migrator converts these settings to 100/5, which results in this configuration for the alert in Anypoint Monitoring:

  • 20 occurrences of alert condition 

  • 10 consecutive periods of 1 minute each

 

  • Assume the API alert in API Manager has this configuration:
    100 occurrences of the alert condition for 8 consecutive periods of 11 minute

The migrator converts these settings to 100/11 (= ~9), which results in this configuration for the alert in Anypoint Monitoring:

  • 9 occurrences of alert condition 

  • 10 consecutive periods of 1 minute each

Numero articolo Knowledge

004634029

 
Caricamento
Salesforce Help | Article