From fbeb95f7d12f55c584503c5633d04b3fb0d4e342 Mon Sep 17 00:00:00 2001 From: Jagadisha V <129049263+JV0812@users.noreply.github.com> Date: Fri, 11 Oct 2024 18:12:45 +0530 Subject: [PATCH 01/25] Usage management - Advanced tab information added --- docs/manage/manage-subscription/index.md | 6 ++ .../manage-subscription/usage-management.md | 66 ++++++++++++++---- sidebars.ts | 1 + .../img/manage/account/create-scan-budget.png | Bin 0 -> 212749 bytes .../account/usage-management-advanced.png | Bin 0 -> 321497 bytes .../img/manage/account/usage-management.png | Bin 86935 -> 74545 bytes .../img/manage/account/view-scan-budget.png | Bin 0 -> 141376 bytes 7 files changed, 59 insertions(+), 14 deletions(-) create mode 100644 static/img/manage/account/create-scan-budget.png create mode 100644 static/img/manage/account/usage-management-advanced.png create mode 100644 static/img/manage/account/view-scan-budget.png diff --git a/docs/manage/manage-subscription/index.md b/docs/manage/manage-subscription/index.md index 88e45aca67..1d77db9308 100644 --- a/docs/manage/manage-subscription/index.md +++ b/docs/manage/manage-subscription/index.md @@ -77,4 +77,10 @@ In this section, we'll introduce the following concepts:
Learn the capabilities included with Sumo Logic’s FedRAMP solution.
+Learn to set query level budget to define spending limits for queries.
+
-1. You will have two options to manage the query size limit:
- - **Unlimited**. By selecting this, no limits will be added to the query. However, if you run an unoptimized query, excessive data will be scanned and accordingly the scan cost will be increased.
- - **Size Limit**. Enter the GB value based on your needs. 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.
+1. **Enable Query Limit**. Select this checkbox and click on **Update limit** to enter the GB value based on your needs. 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. If you leave this checkbox unchecked, no limits will be added to the query. However, if you run an unoptimized query, excessive data will be scanned and accordingly the scan cost will be increased.
1. Click **Save Limit**.
:::note
It may take up to 5 minutes for a newly created budget to become active and enforceable in the system.
:::
-After setting the limit, you can click on the **View violations** button to see any breaches that have occurred. Each breach above the set audit limit will generate an audit log, and you can view the details in the log search using the Sumo Logic's pre-built queries.
+## Advanced
+
+To create the query size limit using **Advanced** configuration:
+
+1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Administration > Account > Usage Management**.
+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 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.
+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, which will block the foreground searches, such as querying in search UI, dashboards, and copilots, but will not impact any background searches, such as scheduled search, monitors, SLO, and API.
+1. **Details**. Enter the name for the scan budget.
+1. Click **Save** to create the scan budget.
+
+:::note
+It may take up to 5 minutes for a newly created budget to become active and enforceable in the system.
+:::
+
+### View deatails about a Scan Budgets
-When you configure multiple budgets for the same user, the scope with the largest capacity takes precedence. If there is still an overlap, the budget with the most restrictive action takes precedence. For example, if you are a part of multiple groups with different query size budgets, the one with the largest capacity will be applied.
+To view the selected scan budget:
-A warning message will be displayed if you run a query that exceeds the budget set, which will block the foreground searches, such as querying in search UI, dashboards, and copilots, but will not impact any background searches, such as scheduled search, monitors, SLO, and API.
+1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Administration > Account > Usage Management**.
+ - **Edit**. Click the **Edit** button to open the pane for editing. Edit the query limit and click on **Save**.
+ :::note
+ You cannot edit the Scope, Action, and Details information.
+ :::
+ - **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**.
+ - **Status**. Describes if the scan budget is active or inactive.
+ - **Usage Category**.
+ - **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.
+ - **Created**. The user who created the scan budget.
+ - **Modified**. The user that most recently modified the scan budget.
+ - **Audit Logs**.
+ - **System Audit**.
diff --git a/sidebars.ts b/sidebars.ts
index 73ca7fde59..85d573478f 100644
--- a/sidebars.ts
+++ b/sidebars.ts
@@ -909,6 +909,7 @@ module.exports = {
'manage/manage-subscription/beta-opt-in',
'manage/manage-subscription/close-cancel-sumo-account',
'manage/manage-subscription/fedramp-capabilities',
+ 'manage/manage-subscription/usage-management',
]
},
{
diff --git a/static/img/manage/account/create-scan-budget.png b/static/img/manage/account/create-scan-budget.png
new file mode 100644
index 0000000000000000000000000000000000000000..4b409217814327b70de891cc871535807e05e6bd
GIT binary patch
literal 212749
zcmeFZcQjnz`aiBjj|h>7P7o5&TZ|r}29YSy34$miMrZVpgy=1L)Too_We_BKZ=;jw
z1|!;FnE4&|zVG+m_5H2ue%AW^{`vlX*IF~@%sG4Sv-h)~v-j(HJn5J1c3{;X>heeQl9Q}
zcP=&Ek VKcMrh!g-QBPy6zk>Ooe8z{7>Yk>
zOud!_p$KRWqHYgI5RkmbT5CTBJd+mOYa+PfSRY06-p)K)-G&I6NI3B=4?y}Ng?5cW
z>5je92b}^opNPuo7;aR=mxs-3=p`-uwW=b{kD)>RSmk=Z@+{>R14((q*oNSz@vaPO
zoKAlgMW}x|ln&jT?Fj#Zl&3{e(814Z82*=RtD8kLAsclmVfVvm2;ey{STG~@5u|`=
zsj1xyTOSA19(D4ub<*E0x&_IGG)AI?LLNaxGj)3l2jXUF?QqYL&4k+r>+Tcp5u@1a
z73JzU8+^ qTI}a
zV~}=d+l6Bct^bVGQdGTd_8Ne}NhTdNBdeVaPLOKr3t)E)$X$`(i9FgH_nq1C_(Xo=OAFO)hVV7h9&k2VqMu?|5
z>(p3)msT;~a)P&(R}^xzAoZj(z$1LP{I@EJSbHlV)e3{|LeH_5qAJEvm9`qjhBaA*
zC6_u&0L9Hpi%}}KS~E^(2lO^))1Y{Ma%a{h*$nX(kkcbXl8Bl53@j3nqK&!6jl2oKZ}~$T);-)JglLI#
zY)gMF-YX2cCr4f-x*dxo5U+$P8fesi7L{D{9iP?zaC_k(Mm1lE=nN*Tj`la<8wzpW
z0E!frz0z@%mey>pBYE^vdT99wjz0~Yu?=IF@X^web?%cJOm&r`8eY$;hbv=CUN?m2
zV4PpPI;Gt=ehC6h4z|HAS`|flc&~5eS-ritTVz(w{z^BkMdj3zT419IOwlki+XcJ6
z(hbZIyEX7#-q=iuv1#9pzm*eZJT}>bVvnu&h|O(U%jYPEX5ODTp$pd1v|)CxFO0hM
zLoGh`FmyYBra#aYp4#yCqh2Ts&Rr;s%@u@--G5<($|mlN-6&hwA~x#l_>*k!RyzgI
z4r-SnYdq>nuwyjzKMN7gS(QM+&7vwtR+3l4$)i13usXcZWu-Dw$`C>R*3rmo?{rE
zk-35ug)Bu+G)>h*ojYXlCs?QG>zGY^RO1qWDmvx3ZQUEu4@c1@Yt+e7@*2MiXwOAs
zd9Mdm0e0`Ib#zp{EI#6^u34=P?GznSsl8OqK)>i#p(74=u&)Mp`D$L`5$D)UoWz-K
zX&Q${l!jDph-yE)nBG<>__sC0-f{OG8V6_spRVxuW&|E8e9}sIaocl5p-sz0#P7Yu
zR;wMNQtd?O6K0qCt<4>~O##2uRrPgchlj_cvgN&ZXbPau%6U3@lAukun01Z
MU&)+%?_s4Oh&(=O7Wz?r9d#x&U+spd25x^Tkv0Ng|kJ
z-xI%355;#`2vG0&g9PAT*fd0eJ(7#8tR!of8HSC$v>2+`
N5|@)O@r{|!yo`|I*b@cK=~z#?Z3vTYTr%cS_dP&EZTd&RN$qM~HXtJSi8501vy
zk8VUp4+nO&>t}eV8{ICxKbLuYp!K>8ss$9)42TUhb0YsZgZJ+S#~+WLS%W=5(;t)(
z#=$)e&F6jEjv9UG<`!G3aA5?Ex@Q{6S;!;jEyl`CBY1YThCN4|$kU~d7%itF>(hIT
z$86gS-UFHZyeBU!jHa4k;c4M&D(&|OUe86;ci$%#4Zj9Ug|1B6z__DQHhwVF%J%c8
zfXKYpTqD>hFDt=%kk;DgmyiEaq28%gq|m+dpKCtRf~~mT*k-UO?i_o#zf`}EIEVxI
z+cq8!8g^aeQzP>nMo=Se?_32p=$&tAto<}CA&