diff --git a/modules/ROOT/pages/_partials/mq-api-shared.adoc b/modules/ROOT/pages/_partials/mq-api-shared.adoc index 4ffd4405..e0c61df4 100644 --- a/modules/ROOT/pages/_partials/mq-api-shared.adoc +++ b/modules/ROOT/pages/_partials/mq-api-shared.adoc @@ -28,3 +28,7 @@ The encoded string is: `startDate=Sun%2C+25+Sep+2022+23%3A35%3A01+GMT&endDate=Wed%2C+25+Sep+2024+23%3A35%3A01+GMT&period=1month` //end::urlEncodedExample[] +//tag::usageDelay[] +Usage information can lag by up to three hours. +//end::usageDelay[] + diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index bc847637..a822b188 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -65,8 +65,8 @@ Send and receive messages from any Mule app, whether it's deployed in CloudHub o + For information, see xref:mq-connectors.adoc[]. Usage Information:: -View the current and past months' usage, including the total number of messages and API requests. -Organization administrators and owners access this information from the *Access Management* page. +View usage data, including the total number of messages and API requests. +Organization administrators and owners access this information from the xref:general::usage-reports.adoc[*Usage Reports*] page. + For information, see xref:mq-usage.adoc[]. REST API:: @@ -230,12 +230,20 @@ Billing is based on the number of messages delivered to subscribers from queues, |{empty} +* xref:mq-usage.adoc[Usage Reports] + + +| Yes +| Yes +| No + +|{empty} + * xref:mq-queues.adoc[Unencrypted Queues] -* xref:mq-usage.adoc#access-mq-usage-charts[Usage Charts] (Access Management) * xref:mq-failover.adoc[Cross-Region Failover] * xref:mq-client-apps.adoc[Client Apps] * xref:mq-connectors.adoc[Anypoint MQ Connector earlier than 4.x] -* xref:mq-apis.adoc#mq-stats-api[Anypoint MQ Stats API] (Usage Metrics) +* xref:mq-apis.adoc#usage-metrics-env-org[Anypoint MQ Stats API] (Usage Metrics) | Yes | No @@ -249,14 +257,6 @@ Billing is based on the number of messages delivered to subscribers from queues, | No | Yes -|{empty} - -* xref:mq-usage.adoc#access-mq-usage-reports[Usage Reports] (Usage) - -| No -| Yes -| No - |=== @@ -267,9 +267,9 @@ When you deploy to https://gov.anypoint.mulesoft.com/login/[MuleSoft Government all features of Anypoint MQ are supported with these exceptions: Unencrypted Queues:: -Unencrypted queues aren'tsupported. +Unencrypted queues aren't supported. + -When xref:mq-queues.adoc#create-a-queue[creating a queue], the *Encryption* option is disabled and defaults to selected. +When xref:mq-queues.adoc#create-a-queue[creating a queue], the *Encryption* option is selected and you can't change it. Client Apps:: xref:mq-client-apps.adoc[Client apps] aren't supported. Use xref:mq-connected-apps.adoc[connected apps] instead. @@ -279,6 +279,9 @@ Anypoint Connector for Anypoint MQ versions earlier than 4.x aren't supported. Using connected apps with Anypoint MQ requires xref:anypoint-mq-connector::index.adoc[Anypoint MQ Connector 4.x for Mule 4]. Cross-Region Failover:: xref:mq-failover.adoc[Cross-region failover] isn't supported. +Usage Reports:: +Usage data in xref:general::usage-reports.adoc[] isn't available. + REST APIs:: These REST APIs in the Anypoint MQ Stats API aren't supported: + @@ -327,11 +330,6 @@ Anypoint Connector for Anypoint MQ versions earlier than 4.x aren't supported. Using connected apps with Anypoint MQ requires xref:anypoint-mq-connector::index.adoc[Anypoint MQ Connector 4.x for Mule 4]. Cross-Region Failover:: xref:mq-failover.adoc[Cross-region failover] isn't supported. -Usage Charts:: -xref:mq-usage.adoc#access-mq-usage-charts[Usage Charts] in Access Management aren't available. -Use -xref:mq-usage.adoc#access-mq-usage-reports[Usage Reports] in Usage instead. - Rest APIs:: These REST APIs in the Anypoint MQ Stats API aren't supported: + @@ -351,6 +349,7 @@ For information, see xref:mq-apis.adoc#mq-stats-api[Anypoint MQ Stats API]. == See Also * xref:hyperforce::index.adoc[] +* xref:general::usage-reports.adoc[] * xref:mq-glossary.adoc[] * xref:mq-connectors.adoc[] * xref:mq-faq.adoc[] diff --git a/modules/ROOT/pages/mq-access-management.adoc b/modules/ROOT/pages/mq-access-management.adoc index 6a04ef9d..d13b601d 100644 --- a/modules/ROOT/pages/mq-access-management.adoc +++ b/modules/ROOT/pages/mq-access-management.adoc @@ -19,6 +19,7 @@ include::reuse::partial$access-management/assign-permissions.adoc[tag=assignPerm [%header,cols="50a,20a,30a"] |=== |To...|Required Permission|Notes +3+h| Anypoint MQ Permissions |include::access-management::partial$include-permissions-mq.adoc[tag=permsViewClients] |View clients | @@ -47,7 +48,6 @@ include::reuse::partial$access-management/assign-permissions.adoc[tag=assignPerm * Destination subscriber for given environment * Destination publisher for given environment - |include::access-management::partial$include-permissions-mq.adoc[tag=permsDestSubEnv] |Destination subscriber for given environment | @@ -59,6 +59,13 @@ include::reuse::partial$access-management/assign-permissions.adoc[tag=assignPerm |include::access-management::partial$include-permissions-mq.adoc[tag=permsReadStats] |Read MQ stats | + +3+h| Usage Reports Permissions +|View usage reports. +|Usage Viewer +|include::access-management::partial$include-root-org-permissions-note.adoc[] + + |=== //// diff --git a/modules/ROOT/pages/mq-apis.adoc b/modules/ROOT/pages/mq-apis.adoc index a5510c97..2adf45e2 100644 --- a/modules/ROOT/pages/mq-apis.adoc +++ b/modules/ROOT/pages/mq-apis.adoc @@ -801,7 +801,7 @@ This command returns output similar to: The period is an integer and is the granularity of data points in seconds. - +[[usage-metrics-env-org]] === Usage Metrics by Environment or Org [NOTE] @@ -853,6 +853,7 @@ This information isn't real-time and has a latency. [NOTE] include::partial$mq-api-shared.adoc[tag=mqStatsAPIlimits] + *Sample Request and Response:* Use this `curl` command to get usage metrics by environment: @@ -889,8 +890,6 @@ include::partial$mq-faq.adoc[tag=returnVals] [[usage-by-org]] ==== Get Usage Metrics by Organization - - You can use the Stats API to retrieve Anypoint MQ usage for the root business organization: `/organizations/?startDate=...&endDate=...&period=...` @@ -898,7 +897,6 @@ You can use the Stats API to retrieve Anypoint MQ usage for the root business or [NOTE] include::partial$mq-api-shared.adoc[tag=mqStatsAPIlimits] - *Sample Request and Response:* Use this `curl` command to get daily usage metrics by organization for a month: diff --git a/modules/ROOT/pages/mq-monitoring.adoc b/modules/ROOT/pages/mq-monitoring.adoc index 5c07b279..201b558e 100644 --- a/modules/ROOT/pages/mq-monitoring.adoc +++ b/modules/ROOT/pages/mq-monitoring.adoc @@ -1,10 +1,11 @@ = Monitoring Anypoint MQ -Use the Anypoint MQ monitoring features to view usage and audit logging data. +Use the Anypoint MQ monitoring features to view usage reports and audit logging data. * xref:mq-usage.adoc[] + -You can view a chart that indicates how much data and how many API requests have been consumed, and how many message units were received. +You can view a report that shows usage for a selected period (total usage and usage by queue or message exchange). +The report includes message units, message bytes, API requests, and messages received. * xref:mq-audit-logs.adoc[] + The Anypoint Platform audit logging service logs Anypoint MQ actions on queues, exchanges, and client applications. diff --git a/modules/ROOT/pages/mq-usage.adoc b/modules/ROOT/pages/mq-usage.adoc index 3e767a13..fea44223 100644 --- a/modules/ROOT/pages/mq-usage.adoc +++ b/modules/ROOT/pages/mq-usage.adoc @@ -1,16 +1,21 @@ = Viewing Anypoint MQ Usage Data -Anypoint MQ uses API requests to calculate billing. +Anypoint MQ uses API requests to calculate billing and message requests to determine the size of message data in the response. +Access Anypoint MQ usage data in xref:general::usage-reports.adoc[]. + +//// Depending on your Anypoint Platform instance, you access usage data in Access Management or Usage. * <> * <> +//// [[api-requests]] API requests:: -API requests are used to calculate your monthly quota for billing. +Anypoint MQ uses API requests to calculate your monthly quota for billing. + +-- ** Every API call (via the connector or API) to Anypoint MQ counts as one API request. + include::partial$mq-faq.adoc[tag=apiRequests] @@ -19,12 +24,13 @@ include::partial$mq-faq.adoc[tag=apiStatsRequests] + ** You can retrieve up to 10 messages from a single API call, which only bills as one request. + -Even if the request to retrieve messages does not return a message (for example, if the queue is empty), +Even if the request to retrieve messages doesn't return a message (for example, if the queue is empty), it bills as a single API request. -** If a queue sends a message to a DLQ, the message is not charged against the billable API requests. +** If a queue sends a message to a DLQ, the message isn't charged against the billable API requests. + However, if a client sends a message directly to a DLQ, that request is charged. - +-- ++ [NOTE] ==== Enabling failover for a queue can result in increased API requests because Anypoint MQ Connector periodically checks the fallback queue for messages to consume. @@ -33,9 +39,9 @@ xref:anypoint-mq-connector::anypoint-mq-failover.adoc#configure-check-frequency[ ==== Message units:: -Message units are not used for billing. +Message units aren't used for billing. + -Message units are used by Anypoint MQ to determine the size of message data in the response. +Anypoint MQ uses message units to determine the size of message data in the response. + ** Each message unit contains 100 KB of data. ** Message units are counted by the number of encoded characters in a message. @@ -43,7 +49,7 @@ Message units are used by Anypoint MQ to determine the size of message data in t //Shared Usage Overage include::partial$mq-faq.adoc[tag=faqUsageOverage] - +//// [[access-mq-usage-charts]] == Access Anypoint MQ Usage Charts @@ -70,7 +76,7 @@ The circle graph changes to red as your usage approaches your license limits: + image::mq-msg-unit-color.png["Circle graph indicating license limit on the MQ Usage page"] + -NOTE: Monthly billing usage information might be delayed by up to 24 hours. +NOTE: Usage information for hourly, daily, and monthly billing might be delayed by up to three hours. .. Subscription type + `Base 0.0` indicates the Base subscription. @@ -80,21 +86,25 @@ Base values greater than `0.0` indicate Premium add-on subscriptions. In some cases, the stats for the current month might not load when the backend process updates the records. If this happens, use the Anypoint MQ Stats API xref:mq-apis.adoc#usage-by-org[Usage Metrics by Organization] to query the daily usage in the current month and then add the daily usage together. - +//// [[access-mq-usage-reports]] == Access Anypoint MQ Usage Reports -[NOTE] -include::partial$mq-on-hyperforce.adoc[tag=mqFeaturesOnlyHFnote] +// [NOTE] +// include::partial$mq-on-hyperforce.adoc[tag=mqFeaturesOnlyHFnote] -To view Anypoint MQ usage reports in Usage: +To view Anypoint MQ stats in xref:general::usage-reports.adoc[]: +. Sign in to Anypoint Platform using an account that has the Usage Viewer permission for your root organization. ++ +For information, see xref:mq-access-management.adoc#anypoint-mq-permissions[Anypoint MQ Permissions]. . In Anypoint Platform, go to *Usage*. . Select *Anypoint MQ* in the *Product* section: + image::mq-usage-report.png["Anypoint MQ option on the Usage Reports page"] . Select a month from the *Monthly Usage Report* tab or day from the *Daily Usage Report* tab. + + The report shows usage for the selected period (total and by object): + @@ -102,10 +112,12 @@ The report shows usage for the selected period (total and by object): * Message bytes * API requests * Messages received ++ +[NOTE] +include::partial$mq-api-shared.adoc[tag=usageDelay] . Click *Export as CSV* to download the usage for the selected period. -For more information, see -xref:general::usage-reports.adoc[]. +For more information, see xref:general::usage-reports.adoc[]. [[retrieve-metrics-api]] == Retrieve Usage Metrics with Anypoint MQ Stats API @@ -123,6 +135,7 @@ include::partial$mq-faq.adoc[tag=apiStatsRequests] == See Also +* xref:general::usage-reports.adoc[] * xref:mq-faq.adoc[Anypoint MQ FAQ] * xref:mq-apis.adoc#mq-stats-api[Anypoint MQ Stats API] * xref:index.adoc#mq-on-hyperforce[Anypoint MQ on Hyperforce]