Viewing Usage Reports
Usage reports provide insights into your monthly usage of Anypoint Platform products.
When you use an Anypoint Platform product, MuleSoft meters your usage and aggregates the records on a monthly basis. Usage reports are updated on the third day of each month and are split by product. All reports are calculated using the UTC time standard.
Use the usage report to compare your actual usage against your existing contract. The report is not for billing purposes.
Some usage data, such as monthly statements and vCore allocation, appears in different areas of Anypoint Platform or Salesforce products.
-
Monthly charges and resource usage appear in your monthly bills.
For more information, see Monthly Account Summaries documentation in Salesforce.
-
Monthly statements for Mule Runtime (including Mule flows, Mule messages, and data throughput) and Automation Credits are sent to the primary billing contract.
See FAQ documentation for details.
-
Runtime Manager vCore allocation information and other metrics appear in Access Management.
For more information, see Runtime Manager Metrics.
-
Anypoiont MQ usage appears in Access Management.
For more information, see Anypoint MQ Metrics.
-
Object Store v2 usage appears in Access Management.
For more information, see Object Store v2 Metrics.
Access Usage Reports
Usage reports are available only when accessing the root organization and do not appear at the business group level.
To access usage reports, you need the Usage Viewer permission. If you don’t have this permission, contact your organization administrator to request access. The Usage Viewer permission must be applied at the root organization level rather than the business group level.
-
Log in to Anypoint Platform using an account that has the Usage Viewer permission over your root organization.
-
Click the circle with your organization name’s initial in it and ensure you are at the root level of your organization and not in a business group.
-
From the Anypoint Platform navigation bar, click your username icon.
-
Click Usage.
-
To see reports for a particular month, click the Monthly Usage Reports drop-down list.
Usage Report Availability
Usage reports are available for the following Anypoint Platform products:
Flex Gateway
Flex Gateway usage reports track monthly API calls. You can view monthly API calls by business group, environment, and registration.
To calculate usage, MuleSoft meters the hourly API calls you make and aggregates the number of API calls on a monthly basis.
API Governance
API Governance usage reports track the maximum number of APIs governed in a given month per business group.
To calculate usage, MuleSoft tracks the number of governed APIs each business group uses per hour and then identifies the maximum number of APIs governed in a month for each business group. To calculate the total count for API Governance, MuleSoft adds the maximum number of governed APIs per month used across all business groups.
Note that the number of governed APIs (both conformant and non-conformant) shown in the API governance console represents a current snapshot of your usage per business group, while the usage report shows the maximum number of APIs you used in a given month per business group.
API Manager
API Manager usage reports track the maximum number of API instances deployed in a given month per business group, environment, and runtime.
To calculate usage, MuleSoft tracks the number of managed API instances each business group, environment, and runtime uses per hour and identifies the maximum number of managed API instances used in a month for each business group, environment, and runtime. To calculate the total count for API Manager, MuleSoft adds the maximum number of managed API instances per month used across business groups, environments, and runtimes.
Mule Runtime
Mule runtime reports track your use of Mule messages, Mule flows, and data throughput.
To track Mule message usage, the runtime report counts the number of times a Mule event source triggers a Mule message. You can view the number of these messages in a given month by business group, environment, and application.
To calculate usage, MuleSoft meters and aggregates the number of messages on a monthly basis. After a message is triggered, the report does not track changes to the message because the message is processed within the application’s flows.
A Mule flow is a sequence of logical operations configured within the XML <flow/> element of a Mule application. The runtime report tracks the Mule flows within a deployed and running Mule application that contains a Mule event source or APIkit route requests. This report does not track other Mule flows. You can view the maximum number of Mule flows in a given month in the usage report.
To calculate usage, MuleSoft tracks the number of Mule flows for all business groups, environments, and applications. The maximum number of Mule flows within a month is identified based on the peak hour across the month. For the detailed breakdown, MuleSoft shows the peak hour usage per business group, environment, and application.
Data throughput is all the network I/O bytes produced by the infrastructure that starts and runs the Mule runtime engine that runs a Mule application. You can view the total amount of GB usage in a given month by business group, environment, and application.
To calculate usage, MuleSoft tracks GB usage and aggregates the total GBs on a monthly basis.
Supported Mule Runtime Versions
To view usage reports for Mule runtime, all of your relevant applications (in production and sandbox) must use the following Mule versions:
| Deployment Type | Version Requirements |
|---|---|
CloudHub 2.0 |
The latest date-patch versions for 4.3, 4.4, and 4.5 |
CloudHub 1.0 |
The latest date-patch versions for 3.9, 4.2, 4.3, 4.4, and 4.5 |
Runtime Fabric |
One of the following versions or any later date-patch: Mule 4 image versions:
Mule 3 image versions:
|
You must redeploy your apps with a supported version, either manually or during the monthly patching cycle. The monthly patching cycle is applicable only for CloudHub 1.0 and CloudHub 2.0 applications. Runtime Fabric customers must be using Runtime Fabric agent version 1.13.112 or 2.1.30 or later. If usage reports do not appear properly, you must also manually redeploy Runtime Fabric applications (with a supported date-patch version).
If you want to roll back to a previous successful configuration of existing applications that use a Mule version that usage reports do not support, you must choose a compliant version before deploying changes. After deployment, a new configuration with the previously chosen settings and a supported runtime is created.
Runtime Fabric Apps in Usage Reports
If usage reports do not display data from Runtime Fabric apps, ensure the following requirements are met:
-
You are using Runtime Fabric agent version 1.13.112, 2.1.30, or later.
-
After updating the Runtime Fabric agent, you have manually redeployed each Runtime Fabric app with a supported date-patch version.
If you are still missing Runtime Fabric apps in your usage reports, contact your account executive to request a report of apps that are not upgraded and what actions need to be taken to update them.