Getting Started

Anypoint Monitoring provides data on Mule apps that are running on either CloudHub or an on-premises server. It is part of the Management Center in Anypoint Platform, and you need to have the Required Permission to use it.

Functional Monitoring is covered in API Functional Monitoring.

Supported Versions of Mule Runtime Engine

Run your Mule app on a supported Mule runtime version. For supported versions, see Mule Runtime Release Notes.

Use Anypoint Monitoring

Log in to Anypoint Platform with a user account that has permission to access Anypoint Monitoring content.
In the navigation bar or the main Anypoint Platform screen, click Monitoring.

If you do not see Anypoint Monitoring or are unable to use it, it might be a permissions issue. See Required Permission.
From Anypoint Monitoring, you can find and use the monitoring tools:

Configurations

Custom dashboards and alerts require configuration before you can use them. For guidance, see:

Required Permission

To use Anypoint Monitoring, you need this permission:

Anypoint Monitoring User

Typically, administrators set permissions through Access Management. See Granting Permissions and Roles to Users.

Enable Anypoint Monitoring on CloudHub

For Anypoint Monitoring to start monitoring your Mule apps, you must deploy them to the appropriate version of Mule runtime engine. See Configure Anypoint Monitoring for Mule Apps (CloudHub).

Enable Anypoint Monitoring On-Premises

You can install Anypoint Monitoring on an on-premises server to monitor applications that are running on that server and managed via Runtime Manager (hybrid apps).

Access Key Metrics through the Anypoint Monitoring Agent

Starting October 31, 2024, access to Key Metrics in API Manager relies on the Anypoint Monitoring agent. The agent is available by default for some Mule app deployment models. Other models require enablement of Anypoint Monitoring or installation of the agent.

Mule App Deployment Model	Action
CloudHub 1.0	Enable Anypoint Monitoring for your Mule Apps. See Setting Up Monitoring for CloudHub Deployments.
CloudHub 2.0	No action is required. Key Metrics and Anypoint Monitoring are available by default.
Runtime Fabric	No action is required. Key Metrics and Anypoint Monitoring are available by default. See also, Setting Up Monitoring for Runtime Fabric Deployments and Supported Versions of Mule Runtime Engine.
Hybrid Deployments	Install the Anypoint Monitoring agent. See Setting Up Monitoring for Hybrid Deployments. If you proxy your monitoring data as it leaves the data center, the proxy must support the SOCKS5 protocol, and you must configure the Anypoint Monitoring agent to communicate through the proxy. See SOCKS5 Proxy Setting.
Standalone Deployments On-Prem	Key Metrics are not supported because standalone deployments are not managed in Anypoint Platform. If you require Key Metrics, convert your standalone deployment to a hybrid deployment (see Add Servers to Runtime Manager), and install the Anypoint Monitoring agent (see Hybrid Deployments).

Mule App Deployment Model

Action

CloudHub 1.0

Enable Anypoint Monitoring for your Mule Apps. See Setting Up Monitoring for CloudHub Deployments.

CloudHub 2.0

No action is required. Key Metrics and Anypoint Monitoring are available by default.

Runtime Fabric

No action is required. Key Metrics and Anypoint Monitoring are available by default. See also, Setting Up Monitoring for Runtime Fabric Deployments and Supported Versions of Mule Runtime Engine.

Hybrid Deployments

Install the Anypoint Monitoring agent. See Setting Up Monitoring for Hybrid Deployments. If you proxy your monitoring data as it leaves the data center, the proxy must support the SOCKS5 protocol, and you must configure the Anypoint Monitoring agent to communicate through the proxy. See SOCKS5 Proxy Setting.

Standalone Deployments On-Prem

Key Metrics are not supported because standalone deployments are not managed in Anypoint Platform. If you require Key Metrics, convert your standalone deployment to a hybrid deployment (see Add Servers to Runtime Manager), and install the Anypoint Monitoring agent (see Hybrid Deployments).