Skip to content
6 changes: 5 additions & 1 deletion modules/ROOT/pages/_partials/osv2-faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
//end::urlEncodedExample[]

//tag::usageDelay[]
Usage information can lag by up to three hours.
//end::usageDelay[]
23 changes: 9 additions & 14 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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].
Expand Down Expand Up @@ -174,14 +180,14 @@ 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


|{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]

Expand All @@ -190,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]]
Expand All @@ -221,17 +219,14 @@ 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.

== See Also

* 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]
Expand Down
4 changes: 3 additions & 1 deletion modules/ROOT/pages/osv2-faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
25 changes: 16 additions & 9 deletions modules/ROOT/pages/osv2-usage.adoc
Original file line number Diff line number Diff line change
@@ -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.

* <<access-usage-charts, US Cloud or EU Cloud>>
* <<access-os-usage-reports, Canada Cloud or Japan Cloud>>
////

[[api-requests]]
API Requests::
Expand Down Expand Up @@ -116,7 +118,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

Expand Down Expand Up @@ -152,15 +154,19 @@ 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[]:

. Sign in to Anypoint Platform using an account that has the Usage Viewer permission for your root organization.
+
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:
+
Expand All @@ -171,12 +177,12 @@ The report shows:
+
** Total effective API requests for the selected period
** 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[].

+
[NOTE]
include::partial$osv2-faq.adoc[tag=usageDelay]
. Click *Export as CSV* to download the usage data for the selected period.

For more information, see xref:general::usage-reports.adoc[].

[[osv2-stats-api]]
== Retrieve Usage Metrics with Object Store v2 Stats API
Expand All @@ -194,4 +200,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]