diff --git a/blog-service/2025-01-23-manage.md b/blog-service/2025-01-23-manage.md new file mode 100644 index 0000000000..2b11056aaf --- /dev/null +++ b/blog-service/2025-01-23-manage.md @@ -0,0 +1,14 @@ +--- +title: Time-Phased Scan Budgets (Manage) +image: https://help.sumologic.com/img/sumo-square.png +keywords: + - time-phased-scan-budgets + - manage +hide_table_of_contents: true +--- + +import useBaseUrl from '@docusaurus/useBaseUrl'; + +icon + +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). \ No newline at end of file diff --git a/docs/manage/manage-subscription/usage-management.md b/docs/manage/manage-subscription/usage-management.md index 816f1e2de3..c6cda7a4c8 100644 --- a/docs/manage/manage-subscription/usage-management.md +++ b/docs/manage/manage-subscription/usage-management.md @@ -40,7 +40,7 @@ It may take up to 5 minutes for a newly created budget to become active and enfo ## Advanced -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. +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. ### Availability @@ -48,14 +48,16 @@ The **Advanced** method for setting query size limits allows you to configure li |:--------------|:--------------------------------------| | Credits | Essentials (Flex) and Enterprise Suite | -### Set query size limit +### Set scan budgets 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**.
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 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. @@ -106,3 +107,6 @@ To view the selected scan budget: 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. +### Exceeding the scan budget + +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.
exceed-scan-budget-warning diff --git a/static/img/manage/account/create-scan-budget.png b/static/img/manage/account/create-scan-budget.png index 3a0d425378..3000b45631 100644 Binary files a/static/img/manage/account/create-scan-budget.png and b/static/img/manage/account/create-scan-budget.png differ diff --git a/static/img/manage/account/exceed-scan-budget-warning.png b/static/img/manage/account/exceed-scan-budget-warning.png new file mode 100644 index 0000000000..27685563d4 Binary files /dev/null and b/static/img/manage/account/exceed-scan-budget-warning.png differ diff --git a/static/img/manage/account/usage-management-advanced.png b/static/img/manage/account/usage-management-advanced.png index 1211f730ed..14009784c1 100644 Binary files a/static/img/manage/account/usage-management-advanced.png and b/static/img/manage/account/usage-management-advanced.png differ diff --git a/static/img/manage/account/view-scan-budget.png b/static/img/manage/account/view-scan-budget.png index d437550cb9..8f3128eb52 100644 Binary files a/static/img/manage/account/view-scan-budget.png and b/static/img/manage/account/view-scan-budget.png differ