From b8a9a0567399c158c77d00a77d381689a5e69425 Mon Sep 17 00:00:00 2001
From: Jagadisha V <129049263+JV0812@users.noreply.github.com>
Date: Mon, 20 Jan 2025 16:49:03 +0530
Subject: [PATCH 1/3] Update Usage management doc
---
.../manage-subscription/usage-management.md | 17 +++++++++--------
.../img/manage/account/create-scan-budget.png | Bin 210766 -> 194509 bytes
.../account/usage-management-advanced.png | Bin 268775 -> 212718 bytes
.../img/manage/account/view-scan-budget.png | Bin 123633 -> 116126 bytes
4 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/docs/manage/manage-subscription/usage-management.md b/docs/manage/manage-subscription/usage-management.md
index 816f1e2de3..3daba7ec0c 100644
--- a/docs/manage/manage-subscription/usage-management.md
+++ b/docs/manage/manage-subscription/usage-management.md
@@ -55,7 +55,9 @@ To create the query size limit using the **Advanced** configuration:
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Administration > Account > Usage Management**.
[**New UI**](/docs/get-started/sumo-logic-ui/). In the top menu, select **Administration**, and then under **Account**, select **Usage Management**. You can also click the **Go To...** menu at the top of the screen and select **Usage Management**.
1. Navigate to **Advanced** tab and click on **+ Create Scan Budget**.
1. **Scope**. Include or exclude the users and roles for whom the scan budget should apply.
-1. **Capacity**. Enter the GB value based on your needs. Sumo Logic recommends setting a GB value per query based on the 95th percentile to stay within safe limits. You can also check the query size of the last 10 queries by clicking on the **Click here** button to help you determine the appropriate size limit.
+1. **Capacity**. You can set either query level or time-phased budgets. You can also check the query size of the last 10 queries by clicking on the **Click here** button to help you determine the appropriate size limit.
+ - **Query level budgets**. Select **Query** from the **Budget Type** dropdown and enter the GB value based on your needs. Sumo Logic recommends setting a GB value per query based on the 95th percentile to stay within safe limits.
+ - **Time phased budgets**. Select **Daily**, **Weekly**, or **Monthly** from the **Budget Type** dropdown and enter the maximum amount of budget in GB. You can set a single shared budget for an entire group by selecting the **Capacity for the Group** option, whereas, you can set a budget for individual user in the selected scope by selecting the **Capacity per User** option.
1. **Action**. Select the type of action/response you require when the budget limit is reached.
- **Show Warning to the user**. Query result will be displayed with a the error message.
- **Only allow background query scans**. A warning message will be displayed if you run a query that exceeds the budget set. This will block the foreground searches but will not impact any background searches/automated queries.
@@ -85,16 +87,15 @@ To view the selected scan budget:
- **Deactivate/Activate**. Click the **Deactivate/Activate** button to deactivate/activate the selected scan budget.
- **Delete**. Click the **Delete** button to delete the selected scan budget.
- **View violations**. Sumo Logic recommends a GB value per query as per the 95th percentile to be within the safe limits. You can also check the query size of the last 10 queries by clicking on **Click here** to help you determine the appropriate size limit.
- - **Budget Type**. Defines the type of budget set.
+ - **Budget Type**. Defines the type of budget set: Query level or time-phased budgets.
- **Per Query Budget**. Limits the data (in GBs) that a single query can consume.
+ - **Time phased budgets**. Limits the data (in GBs) that a single user or a group can consume based on the time phase selected while creating the budget.
- **Status**. Describes if the scan budget is active or inactive.
- **Usage Category**. Describes the type of scan. For Flex this is shown as **Flex Scan** and for Data tier this is shown as **Infrequent Scan**.
- - **Applied to Roles**. Describes the roles for which the selected scan budget is applied for.
- - **Excluded to Roles**. Describes the roles for which the selected scan budget is excluded for.
- - **Applied to Users**. Describes the users for which the selected scan budget is applied for.
- - **Excluded to Roles**. Describes the users for which the selected scan budget is excluded for.
- - **Budget Capacity for individual user**. Describes the budget set for individual user search.
- - **Action**. Describes the type of action sected to notify when the budget limit is reached.
+ - **Scope**. Displays the list of roles or users for whom the selected scan budget is applied for or excluded from.
+ - **Capacity (per user)**. Describes the budget set for individual user search.
+ - **Action when capacity reached**. Describes the type of action sected to notify when the budget limit is reached.
+ - **Reset every day/week/month at**. Displays the time phase when the budget can reset.
- **Created**. The user who created the scan budget.
- **Modified**. The user that most recently modified the scan budget.
- **Audit Logs**. Records the budget definition changes. Click on **View Details** to view the budget definition changes.
diff --git a/static/img/manage/account/create-scan-budget.png b/static/img/manage/account/create-scan-budget.png
index 3a0d425378ea4bf6be37f6263719a4937beffc63..3000b4563169876b8f39d4ef9a3bb51350d3fc58 100644
GIT binary patch
literal 194509
zcmeFZbyytDwmwSmK#+vsp5U6`3?3vn1b0Gk9bkaL2|)u1F2RHA;O+@Ya0o5~3
KBNlMbFI)g2&?aYyoWIx6yVrZyO5d{yntkY)F;jagh
zHM$_nKFmamnzIk26Q>Ep$HaPP>4@6-Aq 4ZJ0+QMF@aU0asLa~3RArOlOqF?Q2_}#J
z$v0xJ{qx(xggzZFntlYDT<$btsoz x<`b7L`A>5*LQfU@PW)6E4i
zy6wS^tcjW*>5xTK29s*bbasCHEz_?P{1K-14#k+KnIlK#`RmD*fcECy
zbi&lmc7QQ*;eokq5Ou_t?>NXBnqqviLr1n%p7Im>5lBT^R3
zL)PQ6J8U#p9{gD`hOPn@o}_=+p81^XVv%{=gFk5-u-%y8(3`gjlGt=Lk_!M$W9A%)
zC4p?*V}4^%M^K131hse4Wt;0|Z}eKUZHLrljJO%8h#rgJl7W78>qd@X@!@2%#Ie!?
zXkA>K)^Tw#$a2u=MaP`YSJ( Fm%tZ!_N`sXQ7EYN4
zP*!kcoac*&mZ8nD)MwOho8QX=+|ajpV{Q92X@le$luBa=_bu;e!jwu%<(h9R?Hnp7
zYC}$T>O+y$a6~<~p51f>;nmaZ6!1zNb%u5YL0-(lajjiZ@SCv2AKl`T?5QEb_sLl3
zN>e{&%VVe8l|Em)&
YG{2xj9u&)>Fm^$uf92wQ^avjYp
zGtP^$dRU)qTj6vu<}__iqgj83?DHKfeH#AUGP4{=o2;$JsqXc9ad#K9$py`om)pv9
ztqj07eS2y}Npm_DwIOzsBXF8M!06`CjL(7vu{K8Ji&SowTOdtRMBlrQLIc;a@tD0-RoV-KTeJ5y>N=aN^y2BSb!
zn{ha(Az7St0%P5!TkColrZPLUAnEtjyg0!I*3!E8T8QbA)ai95zTmE}l#sSIgV}c>
zhiE59Ch*M&<==yGR{SQ!*4LGpHeOYsJJW~F>5
z>7#Hs;4c5j-u@&z?Kt;y*l%%6s2L7WSj=evBOlibNZts&BbH35kU?h}0%80lT5-r3
zf%V}YBll`R5&wt1_Y7-tOT$LD4Mas$R0O0bO+-Mc3Q`m#bfilc=_R0a2t`B@r1uWe
z2_+y^YE-0`&;tn&l}-quB>_U