From 838e18c970ea0cc7ddea0cc407c2b44aa8505688 Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Wed, 18 Dec 2024 12:14:41 -0800 Subject: [PATCH 1/8] W-17396234 OS Start Metering Changes --- modules/ROOT/pages/index.adoc | 9 ++++++++- modules/ROOT/pages/osv2-usage.adoc | 22 +++++++++++++--------- 2 files changed, 21 insertions(+), 10 deletions(-) diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 6c1c688..de74267 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -34,13 +34,14 @@ You can use the existing Object Store connector to write to the object store, re The Object Store v2 user interface is available in the Anypoint Platform > Runtime Manager. - +[[osv2-permissions]] == Object Store v2 Permissions // These descriptions are the same as scopes in connected apps. [%header,cols="50a,20a,30a"] |=== |To...|Required Permission|Notes +3+h| Object Store v2 Permissions |include::access-management::partial$include-permissions-osv2.adoc[tag=permsManageStores] |Manage stores @@ -67,6 +68,11 @@ The Object Store v2 user interface is available in the Anypoint Platform > Runti |Store Metrics Viewer | + +3+h| Usage Reports Permissions +|View usage reports. +|Usage Viewer +|include::access-management::partial$include-root-org-permissions-note.adoc[] |=== To assign user permissions, follow the steps in xref:access-management::users.adoc#grant-user-permissions[Grant Permissions to Users]. @@ -232,6 +238,7 @@ The xref:osv2-apis.adoc#osv2-stats-api[Object Store v2 Stats API] isn't supporte * xref:hyperforce::index.adoc[] * xref:access-management::permissions-by-product.adoc[] +* xref:general::usage-reports.adoc[] * xref:release-notes::object-store/anypoint-osv2-release-notes.adoc[Object Store v2 Release Notes] * xref:connectors::object-store/object-store-connector.adoc[Object Store Connector for Mule 4] * xref:3.9@mule-runtime::object-store-connector.adoc[Object Store Connector for Mule 3] diff --git a/modules/ROOT/pages/osv2-usage.adoc b/modules/ROOT/pages/osv2-usage.adoc index 2eff1ef..d54ca88 100644 --- a/modules/ROOT/pages/osv2-usage.adoc +++ b/modules/ROOT/pages/osv2-usage.adoc @@ -1,11 +1,13 @@ = Rate Limiting and Billing Object Store v2 uses two metrics to determine rate-limiting and billing: API requests and effective API requests. +//// Depending on your Anypoint Platform instance, you access usage data in Access Management or Usage. * <> * <> +//// [[api-requests]] API Requests:: @@ -114,7 +116,7 @@ based on your subscription type: //Shared Usage Overage include::partial$osv2-faq.adoc[tag=faqUsageOverage] - +//// [[access-usage-charts]] == Access Effective API Request Usage Charts @@ -150,16 +152,20 @@ In some cases, the stats for the current month might not load when the backend p If this happens, use the Object Store v2 Stats API xref:osv2-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-os-usage-reports]] == Access Effective API Request Usage Reports -[NOTE] -include::partial$osv2-on-hyperforce.adoc[tag=osv2FeaturesOnlyHFnote] +// [NOTE] +// include::partial$osv2-on-hyperforce.adoc[tag=osv2FeaturesOnlyHFnote] -To view Object Store usage reports in Usage: +To view Object Store usage reports in xref:general::usage-reports.adoc[]: -. In Anypoint Platform, go to *Usage*. +. Sign in to Anypoint Platform using an account that has the Usage Viewer permission for your root organization. ++ +For information, see xref:index.adoc#osv2-permissions[Object Store v2 Permissions]. +. In Anypoint Platform, go to *Usage Reports*. . Select *Object Store* in the *Product* section: + image::os-usage-report.png["Object Store on the Usage Reports page"] @@ -171,10 +177,7 @@ The report shows: ** Effective API requests by store . Click *Export as CSV* to download the usage date for the selected period. -For more information, see -xref:general::usage-reports.adoc[]. - - +For more information, see xref:general::usage-reports.adoc[]. [[osv2-stats-api]] == Retrieve Usage Metrics with Object Store v2 Stats API @@ -192,4 +195,5 @@ To use the Object Store v2 Stats API to retrieve usage metrics, see: == See Also +* xref:general::usage-reports.adoc[] * xref:osv2-faq.adoc[Object Store FAQ] From 7d6eac988a8d6e9234066e97ff57a07d0d38aa5c Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Wed, 18 Dec 2024 14:56:10 -0800 Subject: [PATCH 2/8] fix menu --- modules/ROOT/pages/osv2-usage.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/osv2-usage.adoc b/modules/ROOT/pages/osv2-usage.adoc index d54ca88..746ba3b 100644 --- a/modules/ROOT/pages/osv2-usage.adoc +++ b/modules/ROOT/pages/osv2-usage.adoc @@ -165,7 +165,7 @@ To view Object Store usage reports 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:index.adoc#osv2-permissions[Object Store v2 Permissions]. -. In Anypoint Platform, go to *Usage Reports*. +. In Anypoint Platform, go to *Usage*. . Select *Object Store* in the *Product* section: + image::os-usage-report.png["Object Store on the Usage Reports page"] From ef103f18c8a52b69ede54dfbc123dcd588d64eb5 Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Tue, 7 Jan 2025 15:36:23 -0800 Subject: [PATCH 3/8] formatting issues --- modules/ROOT/pages/osv2-apis.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/osv2-apis.adoc b/modules/ROOT/pages/osv2-apis.adoc index 229d2eb..cb46678 100644 --- a/modules/ROOT/pages/osv2-apis.adoc +++ b/modules/ROOT/pages/osv2-apis.adoc @@ -573,7 +573,8 @@ Use the Stats API to view your entire organization's usage of Object Store for b * `period=1month`: 2 months NOTE: If the interval between `startDate` and `endDate` exceeds the limits, the API returns an HTTP 400 error. -|==== + +|=== [[access-osv2-stats-api]] From 0e6d4c7988487b65525044e9d3ecc4c87440587a Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Tue, 7 Jan 2025 15:51:31 -0800 Subject: [PATCH 4/8] Build log errors --- modules/ROOT/pages/_partials/osv2-on-hyperforce.adoc | 2 +- modules/ROOT/pages/osv2-apis.adoc | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/ROOT/pages/_partials/osv2-on-hyperforce.adoc b/modules/ROOT/pages/_partials/osv2-on-hyperforce.adoc index ce24500..50b6095 100644 --- a/modules/ROOT/pages/_partials/osv2-on-hyperforce.adoc +++ b/modules/ROOT/pages/_partials/osv2-on-hyperforce.adoc @@ -21,4 +21,4 @@ Only the US Cloud and EU Cloud instances of Anypoint Platform support this featu // Note for HF feature only // tag::osv2FeaturesOnlyHFnote[] Only the Canada Cloud and Japan Cloud instances of Anypoint Platform support this feature. -// end:osv2FeaturesOnlyHFnote[] \ No newline at end of file +// end::osv2FeaturesOnlyHFnote[] \ No newline at end of file diff --git a/modules/ROOT/pages/osv2-apis.adoc b/modules/ROOT/pages/osv2-apis.adoc index cb46678..a3eaa66 100644 --- a/modules/ROOT/pages/osv2-apis.adoc +++ b/modules/ROOT/pages/osv2-apis.adoc @@ -573,7 +573,6 @@ Use the Stats API to view your entire organization's usage of Object Store for b * `period=1month`: 2 months NOTE: If the interval between `startDate` and `endDate` exceeds the limits, the API returns an HTTP 400 error. - |=== From ad521d6e7b22e17498aebe3b43e390acbaf61190 Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Tue, 7 Jan 2025 17:53:43 -0800 Subject: [PATCH 5/8] finishing other little changes --- modules/ROOT/pages/_partials/osv2-faq.adoc | 6 +++++- modules/ROOT/pages/index.adoc | 14 +------------- modules/ROOT/pages/osv2-faq.adoc | 4 +++- modules/ROOT/pages/osv2-usage.adoc | 3 +++ 4 files changed, 12 insertions(+), 15 deletions(-) diff --git a/modules/ROOT/pages/_partials/osv2-faq.adoc b/modules/ROOT/pages/_partials/osv2-faq.adoc index 786ffcd..3d1666a 100644 --- a/modules/ROOT/pages/_partials/osv2-faq.adoc +++ b/modules/ROOT/pages/_partials/osv2-faq.adoc @@ -37,4 +37,8 @@ For example, for this decoded value: 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[] \ No newline at end of file +//end::urlEncodedExample[] + +//tag::usageDelay[] +Usage information for all time series - hourly (API), daily, and monthly - can lag by up to three hours. +//end::usageDelay[] \ No newline at end of file diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index de74267..f5eff5e 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -180,6 +180,7 @@ For information about distributed locking in Mule runtime engine, see xref:mule- |{empty} * xref:osv2-connected-apps.adoc[Connected Apps] +* xref:osv2-usage.adoc#access-os-usage-reports[Usage Reports] (Usage) | Yes | Yes @@ -187,7 +188,6 @@ For information about distributed locking in Mule runtime engine, see xref:mule- |{empty} -* xref:osv2-usage.adoc#access-usage-charts[Usage Charts] (Access Management) * xref:cloudhub::deploying-to-cloudhub.adoc[CloudHub 1.0 Deployments] * xref:osv2-apis.adoc#osv2-stats-api[Object Store v2 Stats API] @@ -196,14 +196,6 @@ For information about distributed locking in Mule runtime engine, see xref:mule- | No -|{empty} - -* xref:osv2-usage.adoc#access-os-usage-reports[Usage Reports] (Usage) - -| No -| Yes - - |=== [[osv2-on-hyperforce]] @@ -227,10 +219,6 @@ You can deploy apps to xref:cloudhub-2::ch2-shared-space-about.adoc[CloudHub 2.0 shared spaces] and xref:runtime-fabric::index.adoc[Anypoint Runtime Fabric]. -Usage Charts:: -xref:osv2-usage.adoc#access-usage-charts[Usage Charts] in Access Management aren't available. -Use -xref:osv2-usage.adoc#access-os-usage-reports[Usage Reports] in Usage instead. REST APIs:: The xref:osv2-apis.adoc#osv2-stats-api[Object Store v2 Stats API] isn't supported. diff --git a/modules/ROOT/pages/osv2-faq.adoc b/modules/ROOT/pages/osv2-faq.adoc index 1808c37..530993a 100644 --- a/modules/ROOT/pages/osv2-faq.adoc +++ b/modules/ROOT/pages/osv2-faq.adoc @@ -60,7 +60,9 @@ For information about the Mule object store, see xref:mule-runtime::mule-object- == How can I see usage data? -To view API request data, see xref:osv2-usage.adoc[View Usage Graphs]. +* To view effective API request data in xref:general::usage-reports.adoc[], see xref:osv2-usage.adoc#access-os-usage-reports[Access Effective API Request Usage Reports]. +* To query for effective API requests using the API, see +xref:osv2-apis.adoc#osv2-stats-api[Object Store v2 Stats API]. == What happens when the transaction limit for my subscription is reached? diff --git a/modules/ROOT/pages/osv2-usage.adoc b/modules/ROOT/pages/osv2-usage.adoc index 746ba3b..f19b954 100644 --- a/modules/ROOT/pages/osv2-usage.adoc +++ b/modules/ROOT/pages/osv2-usage.adoc @@ -175,6 +175,9 @@ The report shows: + ** Total effective API requests for the selected period ** Effective API requests by store ++ +[NOTE] +include::partial$osv2-faq.adoc[tag=usageDelay] . Click *Export as CSV* to download the usage date for the selected period. For more information, see xref:general::usage-reports.adoc[]. From 25d8f296beb417c315c33cd00777c2863b442bb6 Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Wed, 8 Jan 2025 11:37:24 -0800 Subject: [PATCH 6/8] typo --- modules/ROOT/pages/osv2-usage.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/osv2-usage.adoc b/modules/ROOT/pages/osv2-usage.adoc index f19b954..7b367d1 100644 --- a/modules/ROOT/pages/osv2-usage.adoc +++ b/modules/ROOT/pages/osv2-usage.adoc @@ -178,7 +178,7 @@ The report shows: + [NOTE] include::partial$osv2-faq.adoc[tag=usageDelay] -. Click *Export as CSV* to download the usage date for the selected period. +. Click *Export as CSV* to download the usage data for the selected period. For more information, see xref:general::usage-reports.adoc[]. From 73550ee4e0d241cf255cc660645a6ef786c3a152 Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Thu, 16 Jan 2025 12:33:02 -0800 Subject: [PATCH 7/8] Update modules/ROOT/pages/_partials/osv2-faq.adoc --- modules/ROOT/pages/_partials/osv2-faq.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/_partials/osv2-faq.adoc b/modules/ROOT/pages/_partials/osv2-faq.adoc index 3d1666a..0310a33 100644 --- a/modules/ROOT/pages/_partials/osv2-faq.adoc +++ b/modules/ROOT/pages/_partials/osv2-faq.adoc @@ -40,5 +40,5 @@ The encoded string is: //end::urlEncodedExample[] //tag::usageDelay[] -Usage information for all time series - hourly (API), daily, and monthly - can lag by up to three hours. +Usage information can lag by up to three hours. //end::usageDelay[] \ No newline at end of file From 73771e51c9965d9460cfab638e2b2ffd534eb71d Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Thu, 16 Jan 2025 14:02:34 -0800 Subject: [PATCH 8/8] peer review Co-authored-by: Tasha Moore <93338373+tasmoore@users.noreply.github.com> --- modules/ROOT/pages/osv2-usage.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/osv2-usage.adoc b/modules/ROOT/pages/osv2-usage.adoc index 7b367d1..9bdc83e 100644 --- a/modules/ROOT/pages/osv2-usage.adoc +++ b/modules/ROOT/pages/osv2-usage.adoc @@ -164,7 +164,7 @@ To view Object Store usage reports 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:index.adoc#osv2-permissions[Object Store v2 Permissions]. +For more information, see xref:index.adoc#osv2-permissions[Object Store v2 Permissions]. . In Anypoint Platform, go to *Usage*. . Select *Object Store* in the *Product* section: +