MuleSoft captures usage data for Mule flows, Mule messages, and data throughput, but not all of this data is aggregated in usage reports.
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 day or month by business group, environment, and application.
To calculate usage, MuleSoft meters and aggregates the number of messages daily and monthly. After a message is triggered, the report doesn’t track changes to the message because the message is processed within the application’s flows.
Data throughput is the total network I/O bytes produced by the infrastructure of the Mule runtime engine running the Mule application.
To calculate usage, MuleSoft tracks usage and aggregates the total daily and monthly GBs.
For Hybrid Standalone, MuleSoft counts usage by deployed apps, Mule flows, and Mule messages. MuleSoft doesn’t count data throughput because the app runs on your infrastructure and you pay for the network traffic. MuleSoft counts data throughput for CloudHub, CloudHub 2.0, and Runtime Fabric.
For some customers in the US control plane, MuleSoft offers a pricing and packaging model for Anypoint Platform that allots a number of Mule flows, Mule messages, and data throughput (measured as network I/O bytes). Not all types of Mule flows and messages count toward the allotments in a package.
Mule Runtime Usage Tables
The usage information shown in the usage report tables changes depending on your view.
Usage by Business Group
Select the Usage by Business Group tab to view:
| Field |
Description |
Business Group |
Business group that owns the resources. For Runtime Fabric, it’s the business group used when creating the Runtime Fabric instance. |
Environment Type |
Environment the resources are associated with.
For Runtime Fabric, it’s the environment the Runtime Fabric instance is associated with. If any production environment is associated with a Runtime Fabric instance, it is considered a production instance. Cluster capacity is not split within a Runtime Fabric instance between preproduction (sandbox) and production environments.
|
Cluster |
Name of the cluster or Runtime Fabric instance containing the applications, workers, and nodes. |
Cluster Capacity (Millicores) |
Allocatable CPU capacity of each node within the Runtime Fabric instance. |
vCore Peak |
Highest hourly vCore consumption for applications in the selected business group and time period. |
Usage by Application
Select the Usage by Application tab to view:
| Field |
Description |
Application |
Name of the Mule application |
Business Group |
Business group that owns the resources. For Runtime Fabric, it’s the business group used when creating the Runtime Fabric instance. |
Deployment Type |
Runtime plane the Mule app is deployed to: CloudHub (abbreviated as CH), CloudHub 2.0 (abbreviated as CH2), or Runtime Fabric (abbreviated as RTF) |
Environment Type |
Preproduction (sandbox) or production environment the Mule app is deployed to. |
Cluster |
The Runtime Fabric instance that contains the nodes and applications |
CPU Limit (Millicores) |
Maximum amount of CPU allocated by the user that the application can burst to within the shared cluster or Runtime Fabric instance |
CPU Reserve (Millicores) |
Amount of CPU allocated by the user to reserve for applications within the Runtime Fabric cluster or instance |
HPA Status |
Indicates whether Horizontal Pod Autoscaling (HPA) is enabled for the application. Displays Enabled or N/A. |
vCore Peak |
Highest hourly vCore consumption for the application within the selected time period. |
vCore Min |
Guaranteed base vCore allocation for the application, based on the minimum replica configuration. For CloudHub (CH1) applications, vCore Min equals vCore Peak. |
Mule Flows |
Total number of flows in the Mule app, calculated by multiplying flows by the number of workers (CH1) or replicas (CH2 and RTF). |
Mule Messages |
Total number of inbound and outbound Mule messages in the Mule app |
Data Throughput (GB) |
Total amount of inbound and outbound data in gigabytes (GB) transmitted by the Mule app |
Mule Runtime Usage Cards
MuleSoft usage reports cards include:
Maximum Mule 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.
Mule apps in production environments typically use multiple Mule flows and subflows to divide the app into functional modules or for error-handling purposes. For example, one Mule flow might receive a record and transform data into a given format that another flow processes.
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 day or month is identified based on the peak-hour usage across the day or month. For the detailed breakdown, MuleSoft shows the peak hour usage per business group, environment, and application.
In a usage report, flow counts are calculated by multiplying the number of flows in an app by the number of workers (CloudHub) or replicas (CloudHub 2.0 and Runtime Fabric).
These Mule flows count toward your allotment:
MuleSoft counts all flows that include an event source, regardless of whether the flow initialState is started or stopped. Mule flows are charged only when the application containing the Mule flow is deployed and running.
Mule Flow with an Event Source
This Mule flow contains an event source as the first element. In this case, the listener counts towards your allotment.
<flow name="test-flow" >
<http:listener config-ref="cocheras-puerto-madero-api-httpListenerConfig" path="/daily-report"/>
<logger level="INFO" message="#[output json --- attributes.queryParams]" />
</flow>
Examples of Event Sources
| Connector |
Source |
aggregators |
aggregator-listener |
amqp |
listener |
apikit-odata |
request-entity-collection-listener |
request-entity-listener |
as2-mule4 |
as2-listener |
as2-mdn-listener |
non-repudiation-listener |
azure-service-bus-messaging |
message-listener |
core |
scheduler |
db |
listener |
email |
listener-imap |
listener-pop3 |
file |
listener |
ftp |
listener |
ftps |
listener |
google-sheets |
new-row-listener |
new-spreadsheet-listener |
updated-row-listener |
http |
listener |
ibm-mq |
listener |
jms |
listener |
kafka |
batch-message-listener |
message-listener |
mllp |
mllp-listener |
netsuite |
deleted-object-listener |
modified-object-listener |
modified-record-listener |
new-record-listener |
pubsub |
message-listener |
salesforce |
deleted-object-listener |
modified-object-listener |
new-object-listener |
replay-channel-listener |
replay-topic-listener |
subscribe-channel-listener |
subscribe-topic-listener |
sap |
document-listener |
function-listener |
servicebus |
listener |
sftp |
listener |
sockets |
listener |
solace |
queue-listener |
topic-listener |
sqs |
receive-messages |
receivemessages |
stripe |
citizen-on-new-charge-listener |
on-new-charge-listener |
on-new-event-listener |
vm |
listener |
websocket |
inbound-listener |
outbound-listener |
Mule Flows Generated by APIkit and Used for Routing APIkit Requests
APIkit is a tool that simplifies API implementation by automatically generating a minimal set of Mule flows based on the API specification. Each APIkit router endpoint counts as a distinct Mule flow. These Mule flows don’t have an event source and are used to HTTP requests for a particular API method and path.
This flow routes APIkit requests and handles the GET request in the /reservation path:
<flow name="get:\reservation:cocheras-puerto-madero-api-config">
<logger level="INFO" message="#[output json --- attributes.queryParams]" />
</flow>
Mule Flows That Don’t Count Against Your Anypoint Platform Package Allotment
Mule flows that don’t have an event source and aren’t used for routing APIkit requests aren’t charged against your Anypoint Platform package allotment. These Mule flows are primarily used to modularize code.
2.a - Flow with only a logger component
<flow name="just-logging">
<logger level="INFO" message="#[output json --- attributes.queryParams]" />
</flow>
Total Mule Messages
A Mule message is the data (the payload and its attributes) that passes through one or more Mule flows in an application. A Mule message is part of a Mule event, which is generated when the event source within a Mule flow is triggered. For example, a Mule event that consists of a Mule message is created when an HTTP Listener receives a request or each time the Scheduler component triggers an execution of the Mule flow.
Mule message processors in a Mule flow (such as core components, file read operations, or the HTTP request operations) can then retrieve, set, and process Mule message data that resides in the Mule event according to their configurations.
A Mule message is immutable, so every change to a Mule message results in the creation of a new instance. Each processor in a flow that receives a Mule message returns a new Mule message that consists of a message payload (the body of the message) and message attributes (metadata associated with the message).
Mule Message Scenarios That Count Toward Your Anypoint Platform Package Allotment
When an event source within a flow of a Mule application is triggered, the event source such as HTTP Listener or Scheduler, generates a Mule event that encapsulates a Mule message. The Mule message generated by the event source counts toward your Anypoint Platform package allotment. Any new instances of that message created during the processing of the original message as it moves through other processors in connected Mule flows, don’t count toward your Anypoint Platform package allotment.
Total Data Throughput
Data throughput is all of the network I/O bytes produced by the infrastructure for the Mule runtime server that runs a Mule application. This includes the data that the application produces to execute its business logic, as well as internal operational network traffic such as logs, health checks, and monitoring traffic. For example, data throughput includes inserting a record into a database and the network traffic associated with the app infrastructure, such as log forwarding, control plane connection, and monitoring metrics transfer.
MuleSoft doesn’t count data throughput for Hybrid Standalone. MuleSoft counts data throughput for CloudHub, CloudHub 2.0, and Runtime Fabric.