From 54b5a400acede2695e0a380acec76d3bc2407896 Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Wed, 18 Dec 2024 12:37:26 -0800 Subject: [PATCH 1/3] W-17396234 MQ OS Metering Changes --- modules/ROOT/pages/usage-metrics.adoc | 5 +++-- modules/ROOT/pages/usage-reports.adoc | 22 +++------------------- 2 files changed, 6 insertions(+), 21 deletions(-) diff --git a/modules/ROOT/pages/usage-metrics.adoc b/modules/ROOT/pages/usage-metrics.adoc index 2d7325d4..b69c1b70 100644 --- a/modules/ROOT/pages/usage-metrics.adoc +++ b/modules/ROOT/pages/usage-metrics.adoc @@ -50,11 +50,12 @@ a|If an API is governed, all versions of that API are considered one governed AP |Message Queue |Anypoint MQ API request: A request made to retrieve one or more messages from the Anypoint MQ APIs -|Each Anypoint MQ API request includes up to 100 KB of data. An Anypoint MQ API request over 100 KB counts as multiple requests with no fractional units. Anypoint MQ API requests are calculated in the aggregate across all environments (including production, pre-production, sandbox, and design). Anypoint MQ API requests are currently available only via API and aren’t aggregated on usage reports. +|Each Anypoint MQ API request includes up to 100 KB of data. An Anypoint MQ API request over 100 KB counts as multiple requests with no fractional units. Anypoint MQ API requests are calculated in the aggregate across all environments (including production, pre-production, sandbox, and design). +Anypoint MQ API requests are available via API and aggregated on usage reports. |Object Store |Object Store API request: A request made to retrieve one or more messages from the Object Store APIs as further defined in the Object Store documentation -|Each Object Store API request includes up to 100 KB of data. Object Store API requests over 100 KB count as multiple requests with no fractional units. Object Store API requests are currently available only via API and aren’t aggregated on usage reports. +|Each Object Store API request includes up to 100 KB of data. Object Store API requests over 100 KB count as multiple requests with no fractional units. Object Store API requests are available via API and aggregated on usage reports. |DataGraph |DataGraph orchestration: An API request made by Anypoint DataGraph to the source APIs to get data for the GraphQL API request made to Anypoint DataGraph diff --git a/modules/ROOT/pages/usage-reports.adoc b/modules/ROOT/pages/usage-reports.adoc index 358228a1..b0a69ea8 100644 --- a/modules/ROOT/pages/usage-reports.adoc +++ b/modules/ROOT/pages/usage-reports.adoc @@ -19,29 +19,20 @@ For more information, see https://help.salesforce.com/s/articleView?id=000390885 * Runtime Manager vCore allocation information and other metrics appear in Access Management. + For more information, see xref:pricing-metrics.adoc#runtime-manager-metrics[Runtime Manager Metrics]. -* xref:mq::mq-usage.adoc#access-anypoint-mq-usage[Anypoint MQ] usage appears in Access Management. -+ -For more information, see xref:pricing-metrics.adoc#mq-metrics[Anypoint MQ Metrics]. -* xref:object-store::osv2-usage.adoc#access-object-store-effective-api-request-usage-charts[Object Store v2] usage appears in Access Management. -+ -For more information, see xref:usage-metrics.adoc#object-store-metrics[Object Store v2 Metrics]. [[products-usage-reports]] == Products Available in Usage Reports The following products are available in usage reports: +* xref:mq::mq-usage.adoc[Anypoint MQ] * 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 +* Mule Runtime +* xref:object-store::osv2-usage.adoc[Object Store v2] == Supported Mule Runtime Versions @@ -72,13 +63,6 @@ You can export both daily and monthly usage reports to CSV files. These metrics == Usage Reports on Hyperforce All features of Usage Reports are supported on Hyperforce. -NOTE: Anypoint MQ and Object Store usage reports are available only on Hyperforce. They aren't available on US Cloud and EU Cloud. - -For more information, see: - -* xref:mq::mq-usage.adoc#access-mq-usage-reports[Access Anypoint MQ Usage Reports] -* xref:object-store::osv2-usage.adoc#access-os-usage-reports[Access Effective API Request Usage Reports] - == See Also * xref:api-governance::index.adoc[] From 040dbdc7e700fb1ba105d6a23605ed5cf693123c Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Wed, 15 Jan 2025 16:08:32 -0800 Subject: [PATCH 2/3] Kimaya review plus new sections --- modules/ROOT/pages/usage-metrics.adoc | 48 +++++++++++++++++++++++++-- 1 file changed, 46 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/usage-metrics.adoc b/modules/ROOT/pages/usage-metrics.adoc index 0673c294..f1f267da 100644 --- a/modules/ROOT/pages/usage-metrics.adoc +++ b/modules/ROOT/pages/usage-metrics.adoc @@ -48,9 +48,10 @@ a|If an API is governed, all versions of that API are considered one governed AP |Robotic Process Automation (“RPA”) bot minutes: The number of minutes running process automations across all bot sessions |A single bot can run multiple parallel sessions, with RPA bot minutes counting for each parallel session. You can configure multiple bots to run the same process, with RPA bot minutes counting for each of these separate bot sessions. Test runs or process runs in the test phase are also counted towards RPA bot minutes. -|Message Queue +|Anypoint MQ |Anypoint MQ API request: A request made to retrieve one or more messages from the Anypoint MQ APIs -|Each Anypoint MQ API request includes up to 100 KB of data. An Anypoint MQ API request over 100 KB counts as multiple requests with no fractional units. Anypoint MQ API requests are calculated in the aggregate across all environments (including production, pre-production, sandbox, and design). +|Anypoint MQ uses API requests to calculate billing. +Anypoint MQ API requests are calculated in the aggregate across all environments (including production, pre-production, sandbox, and design). Anypoint MQ API requests are available via API and aggregated on usage reports. |Object Store @@ -66,6 +67,30 @@ Anypoint MQ API requests are available via API and aggregated on usage reports. | IDP document actions might process documents that have more than one page, with each page counting separately. When RPA executes document actions, it also counts towards document pages and additionally consumes the corresponding RPA Bot Minutes, accounting for the time the RPA process runs. |=== +== Anypoint MQ Usage + +Anypoint MQ usage reports show this information in tables and cards: + +Message units:: +Number of encoded characters in a message, used to determine the size of message data in the response for rate limiting (not billing) +Messages bytes:: +Size of the message data in the response, based on message units +API requests:: +Number of API calls via the connector or API, used to calculate monthly quota for billing +Messages received:: +Number of messages received +Total Message units:: +Sum of message units across all queues in the organization +Total Messages bytes:: +Sum of message data across all queues in the organization +Total API requests:: +Sum of API calls across all queues in the organization +Total Messages received:: +Sum of messages received across all queues in the organization + +For more information, see xref:mq::mq-usage.adoc[]. + + == API Experience Hub Usage API Experience Hub usage reports show this information in tables and cards: @@ -317,6 +342,25 @@ When an event source within a flow of a Mule application is triggered, the event 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. +== Object Store Usage + +Object Store v2 usage reports show this information in tables and cards: + +Business Group:: +Business group that owns the resources where the app with the object store is deployed +Environment:: +Environment within the business group where the app with the object store is deployed +Region id:: +Region where the app with the object store is deployed +Store:: +Name of the object store associated with the API requests +Effective API requests:: +API requests along with the payload size and number of keys returned, used to calculate units against the quota +Total Effective API requests:: +Sum of effective API requests that return a 2xx (success) response across all object stores in the organization + +For more information, see xref:object-store::osv2-usage.adoc[]. + [[rtf-usage-metrics]] == Runtime Fabric Usage Metrics From ecde4013cce796f1f32580e2b45458b3c16a8088 Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Wed, 15 Jan 2025 16:13:49 -0800 Subject: [PATCH 3/3] more fields --- modules/ROOT/pages/usage-metrics.adoc | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/modules/ROOT/pages/usage-metrics.adoc b/modules/ROOT/pages/usage-metrics.adoc index f1f267da..8c7e7433 100644 --- a/modules/ROOT/pages/usage-metrics.adoc +++ b/modules/ROOT/pages/usage-metrics.adoc @@ -71,6 +71,16 @@ Anypoint MQ API requests are available via API and aggregated on usage reports. Anypoint MQ usage reports show this information in tables and cards: +Business Group:: +Business group that owns the resources where the app with the queue is deployed +Environment:: +Environment within the business group where the app with the queue is deployed +Region id:: +Region where the app with the queue is deployed +Object type:: +Queue or message exchange +Object name:: +Name of the queue or message exchange Message units:: Number of encoded characters in a message, used to determine the size of message data in the response for rate limiting (not billing) Messages bytes::