Skip to content

Commit a8a71c7

Browse files
JV0812kimsauce
andauthored
Update Usage management doc (#4975)
* Update Usage management doc * Update docs/manage/manage-subscription/usage-management.md Co-authored-by: Kim (Sumo Logic) <[email protected]> * added release notes --------- Co-authored-by: Kim (Sumo Logic) <[email protected]>
1 parent 6669b33 commit a8a71c7

File tree

6 files changed

+28
-10
lines changed

6 files changed

+28
-10
lines changed

blog-service/2025-01-23-manage.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Time-Phased Scan Budgets (Manage)
3+
image: https://help.sumologic.com/img/sumo-square.png
4+
keywords:
5+
- time-phased-scan-budgets
6+
- manage
7+
hide_table_of_contents: true
8+
---
9+
10+
import useBaseUrl from '@docusaurus/useBaseUrl';
11+
12+
<a href="https://help.sumologic.com/release-notes-service/rss.xml"><img src={useBaseUrl('img/release-notes/rss-orange2.png')} alt="icon" width="50"/></a>
13+
14+
We're excited to introduce the time-phased scan budgets for advanced usage management, which helps you to set **Daily**, **Weekly**, or **Monthly** budgets for individual user or a single shared budget for an entire group. [Learn more](/docs/manage/manage-subscription/usage-management/#set-scan-budgets).

docs/manage/manage-subscription/usage-management.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,22 +40,24 @@ It may take up to 5 minutes for a newly created budget to become active and enfo
4040

4141
## Advanced
4242

43-
The **Advanced** method for setting query size limits allows you to configure limits for individual users and helps admins assign roles for easier group selection. This method also provides flexibility in your actions when the budget limit is reached.
43+
The **Advanced** method for setting scan budgets allows you to configure limits for individual users and helps admins assign roles for easier group selection. This method also provides flexibility in your actions when the budget limit is reached.
4444

4545
### Availability
4646

4747
| Account Type | Account Level |
4848
|:--------------|:--------------------------------------|
4949
| Credits | Essentials (Flex) and Enterprise Suite |
5050

51-
### Set query size limit
51+
### Set scan budgets
5252

5353
To create the query size limit using the **Advanced** configuration:
5454

5555
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Administration > Account > Usage Management**. <br/> [**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**.
5656
1. Navigate to **Advanced** tab and click on **+ Create Scan Budget**. <br/><img src={useBaseUrl('/img/manage/account/usage-management-advanced.png')} alt="usage-management" style={{border:'1px solid gray'}} width="800"/>
5757
1. **Scope**. Include or exclude the users and roles for whom the scan budget should apply.
58-
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.
58+
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.
59+
- **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.
60+
- **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.
5961
1. **Action**. Select the type of action/response you require when the budget limit is reached.
6062
- **Show Warning to the user**. Query result will be displayed with a the error message.
6163
- **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:
8587
- **Deactivate/Activate**. Click the **Deactivate/Activate** button to deactivate/activate the selected scan budget.
8688
- **Delete**. Click the **Delete** button to delete the selected scan budget.
8789
- **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.
88-
- **Budget Type**. Defines the type of budget set.
90+
- **Budget Type**. Defines the type of budget set: Query level or time-phased budgets.
8991
- **Per Query Budget**. Limits the data (in GBs) that a single query can consume.
92+
- **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.
9093
- **Status**. Describes if the scan budget is active or inactive.
9194
- **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**.
92-
- **Applied to Roles**. Describes the roles for which the selected scan budget is applied for.
93-
- **Excluded to Roles**. Describes the roles for which the selected scan budget is excluded for.
94-
- **Applied to Users**. Describes the users for which the selected scan budget is applied for.
95-
- **Excluded to Roles**. Describes the users for which the selected scan budget is excluded for.
96-
- **Budget Capacity for individual user**. Describes the budget set for individual user search.
97-
- **Action**. Describes the type of action sected to notify when the budget limit is reached.
95+
- **Scope**. Displays the list of roles or users for whom the selected scan budget is applied for or excluded from.
96+
- **Capacity (per user)**. Describes the budget set for individual user search.
97+
- **Action when capacity reached**. Describes the type of action sected to notify when the budget limit is reached.
98+
- **Reset every day/week/month at**. Displays the time phase when the budget can reset.
9899
- **Created**. The user who created the scan budget.
99100
- **Modified**. The user that most recently modified the scan budget.
100101
- **Audit Logs**. Records the budget definition changes. Click on **View Details** to view the budget definition changes.
@@ -106,3 +107,6 @@ To view the selected scan budget:
106107

107108
When you configure multiple budgets for the same user, the scope with the largest capacity takes precedence. However, if the budgets are of same values (for example, Budget A and Budget B are of same value 10 GB) then the most restrictive budget takes precedence.
108109

110+
### Exceeding the scan budget
111+
112+
When you perform a log search, if the results exceed the specified capacity limit, an error message will be displayed with no results. For example, consider you set a budget of 1 GB/query, and when your log search results exceed the set budget limit, an error message will be displayed as shown below.<br/><img src={useBaseUrl('/img/manage/account/exceed-scan-budget-warning.png')} alt="exceed-scan-budget-warning" style={{border:'1px solid gray'}} width="400"/>
-15.9 KB
Loading
82.2 KB
Loading
-54.7 KB
Loading
-7.33 KB
Loading

0 commit comments

Comments
 (0)