Skip to content

Commit 6cb96e0

Browse files
JV0812jpipkin1
andauthored
Release note update - Scan Budget (#4716)
* Release note update * added note to usage management docs * Update blog-service/2024-10-29-manage.md * Update docs/manage/manage-subscription/usage-management.md --------- Co-authored-by: John Pipkin (Sumo Logic) <[email protected]>
1 parent d2267dd commit 6cb96e0

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

blog-service/2024-10-29-manage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ We are happy to introduce our new **Usage Management** tab under the **Accounts*
1616
Key features include:
1717

1818
- **Org-wide query budget**. Set a budget for queries that applies to all users in the organization.
19-
- **User-level query budget**. Set a budget for queries at the user level. With this, *Admins* can specify roles and easily select groups based on roles.
19+
- **User level and role level query budget**. Set limits on query data volume at the user level and role level.
2020
- **Flexible actions**. Choose what happens when the budget limit is reached. Options include **Display a warning to the user** or **Restrict queries to background scans only**.
2121

2222
Explore our technical documentation [here](/docs/manage/manage-subscription/usage-management/) to learn how to set up and use Scan Budgets.

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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ To manage the query size limit using the **Basic** configuration:
2828
1. **Enable Query Limit**. Select this checkbox 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. 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.
2929
1. Click **Save Limit**.
3030

31+
:::info
32+
Sumo Logic defines scan as two types:
33+
- **Foreground interactive search**. Search page UI, Copilot, and Dashboards.
34+
- **Background search**. API, Scheduled Search, Monitor, and SLO.
35+
:::
36+
3137
:::note
3238
It may take up to 5 minutes for a newly created budget to become active and enforceable in the system.
3339
:::
@@ -52,7 +58,12 @@ To create the query size limit using the **Advanced** configuration:
5258
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 **Click here** to help you determine the appropriate size limit.
5359
1. **Action**. Select the type of action/response you require when the budget limit is reached.
5460
- **Show Warning to the user**. Query result will be displayed with a the error message.
55-
- **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 the search UI and dashboards, but will not impact any background searches, such as scheduled search, monitors, SLO, and API.
61+
- **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.
62+
:::info
63+
Sumo Logic defines scan as two types:
64+
- **Foreground interactive search**. Search page UI, Copilot, and Dashboards.
65+
- **Background search**. API, Scheduled Search, Monitors, and SLO.
66+
:::
5667
1. **Details**. Enter the name for the scan budget.<br/><img src={useBaseUrl('/img/manage/account/create-scan-budget.png')} alt="create-scan-budget" style={{border:'1px solid gray'}} width="650"/>
5768
1. Click **Save** to create the scan budget.
5869

0 commit comments

Comments
 (0)