Usage Reports
Usage reports provide comprehensive monthly and daily summaries that give you valuable insights into your resource use across Anypoint Platform products. By correlating your usage with billing cycles, you can gain insights into the factors influencing your costs, which enables you to proactively manage your budget and make informed decisions to optimize your resource allocation.
When you use an Anypoint Platform product that is metered, MuleSoft measures your usage and aggregates the records on a daily and monthly basis. Monthly and daily usage reports have a three-day latency, meaning that today’s usage is available in three days. All reports are calculated using the UTC time standard. For example, a daily usage is aggregated from 00:00 to 00:00 UTC.
Daily usage retention is three months and monthly usage retention is up to five years.
Organizations that have a usage-based pricing model can compare actual usage from the report against the existing contract. However, usage reports are not for billing purposes. For more information about usage metrics and pricing, read Anypoint Platform Pricing and Usage and Pricing Metrics Reference
Some usage data, such as monthly statements and vCore allocation, appears in different areas of Anypoint Platform or Salesforce products.
-
Monthly statements for Mule runtime, including Mule flows, Mule messages, and data throughput are sent to the primary billing contact.
Automation credits for RPA, (Composer, Intelligent Document Processing (IDP), and API Experience Hub) are sent to the primary billing contact.
For more information, see Monthly Account Summaries documentation in Salesforce.
-
Runtime Manager vCore allocation information and other metrics appear in Access Management.
For more information, see Runtime Manager Metrics.
-
Anypoint 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.
Products Available in Usage Reports
The following products are available in usage reports:
-
API Experience Hub
-
API Governance
-
API Manager
-
Flex Gateway
-
Mule Runtime
-
Intelligent Document Processing (IDP)
The following products are available only in usage reports on Hyperforce:
-
Anypoint MQ
-
Object Store
Supported Mule Runtime Versions
To view usage reports for Mule runtime, all 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.0 and later |
CloudHub |
The latest date-patch versions for 3.9 and 4.2.0 and later |
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 and CloudHub 2.0 applications.
You can roll back to a previous successful application configuration. However, if an app is using a Mule version not supported by usage reports, you must choose a compliant Mule version before deploying changes. After deployment, a new configuration with the previously chosen settings and a supported runtime is created.
Before You Begin
Usage reports are available only when you’re signed in to the root organization and don’t 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.
Access Usage Reports
-
Sign in to Anypoint Platform using an account that has the Usage Viewer permission for your root organization.
-
In the Anypoint Platform navigation bar, click the business group selector, and ensure you are at the root organization level.
-
In the Anypoint Platform navigation bar, click your username icon and select Usage.
-
Select the product for which to view a usage report.
-
Click Monthly Usage Report or Daily Usage Report.
-
Select the month or day of the usage report to view. For the selected product, only dates that Anypoint Platform collected data for are available.
The usage report appears, displaying an assortment of usage metrics that are dependent on the product you selected.
Export Usage Reports to a CSV File
You can export both daily and monthly usage reports to CSV files. These metrics match the data available in usage reports.
-
Navigate to the usage report to download.
-
Click Export as CSV.