Skip to content

Commit a1e6c17

Browse files
committed
Scan Budget docs
1 parent 6215ffe commit a1e6c17

File tree

13 files changed

+71
-60
lines changed

13 files changed

+71
-60
lines changed

blog-service/2024/12-31.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -331,15 +331,15 @@ Minor *query* fixes in the below [Classic Apps (Legacy)](/docs/get-started/apps-
331331

332332
#### Scan Budgets
333333

334-
We are happy to introduce our new **Usage Management** tab under the **Accounts** section. This feature allows you to define query spending limits, helping prevent unexpected charges and manage Sumo Logic credits, particularly in pay-per-use scenarios by limiting search volume.
334+
We are happy to introduce our new **Scan Budgets** tab under the **Accounts** section. This feature allows you to define query spending limits, helping prevent unexpected charges and manage Sumo Logic credits, particularly in pay-per-use scenarios by limiting search volume.
335335

336336
Key features include:
337337

338338
- **Org-wide query budget**. Set a budget for queries that applies to all users in the organization.
339339
- **User level and role level query budget**. Set limits on query data volume at the user level and role level.
340340
- **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**.
341341

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

344344
### October 29, 2024 (Apps)
345345

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,4 @@ hide_table_of_contents: true
99

1010
import useBaseUrl from '@docusaurus/useBaseUrl';
1111

12-
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).
12+
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/scan-budgets).

cid-redirects.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2461,7 +2461,8 @@
24612461
"/cid/5238": "/docs/send-data/collection/processing-rules/mask-rules",
24622462
"/cid/5239": "/docs/search/search-query-language/search-operators/matches",
24632463
"/cid/524": "/docs/manage/manage-subscription/cloud-flex-legacy-accounts",
2464-
"/cid/5355": "/docs/manage/manage-subscription/usage-management",
2464+
"/cid/5355": "/docs/manage/manage-subscription/organization-usage-limits",
2465+
"/cid/5366": "/docs/manage/manage-subscription/scan-budgets",
24652466
"/cid/5241": "/docs/metrics/metrics-operators/max",
24662467
"/cid/5244": "/docs/metrics/metrics-operators/min",
24672468
"/cid/5245": "/docs/search/get-started-with-search/search-page/modify-search-from-messages-tab",

docs/api/scan-budget.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ The Scan Budget Management APIs allows you to manage scan budgets from HTTP endp
3838

3939
<ApiRoles/>
4040

41-
* Usage Management
42-
* View Usage Management
43-
* Manage Usage Management
41+
* Scan Budget
42+
* View Scan Budget
43+
* Manage Scan Budget
4444

45-
To manage scan budgets, you must have the **Manage Usage Management** role capability. Enabling this will also automatically enable the **View Usage Management** capability.
45+
To manage scan budgets, you must have the **Manage Scan Budget** role capability. Enabling this will also automatically enable the **View Scan Budget** capability.

docs/manage/manage-subscription/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,16 @@ In this section, we'll introduce the following concepts:
4949
</div>
5050
<div className="box smallbox card">
5151
<div className="container">
52-
<a href="/docs/manage/manage-subscription/usage-management"><img src={useBaseUrl('img/icons/operations/manage.png')} alt="icon" width="40"/><h4>Usage Management</h4></a>
52+
<a href="/docs/manage/manage-subscription/organization-usage-limits"><img src={useBaseUrl('img/icons/operations/manage.png')} alt="icon" width="40"/><h4>Organization Usage Limits</h4></a>
5353
<p>Learn to set query-level budget to define spending limits for queries.</p>
5454
</div>
5555
</div>
56+
<div className="box smallbox card">
57+
<div className="container">
58+
<a href="/docs/manage/manage-subscription/scan-budgets"><img src={useBaseUrl('img/icons/operations/manage.png')} alt="icon" width="40"/><h4>Scan Budget</h4></a>
59+
<p>Learn to set advacned query-level budget to define spending limits for queries.</p>
60+
</div>
61+
</div>
5662
<div className="box smallbox card">
5763
<div className="container">
5864
<a href="/docs/manage/manage-subscription/fedramp-capabilities"><img src={useBaseUrl('img/icons/operations/manage.png')} alt="icon" width="40"/><h4>FedRAMP Capabilities</h4></a>
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
id: organization-usage-limits
3+
title: Organization Usage Limits
4+
description: Learn to set query level budget to define spending limits for queries.
5+
---
6+
7+
import useBaseUrl from '@docusaurus/useBaseUrl';
8+
9+
This page provides information about the query budget usage limits, which allows you to define spending limits for queries to prevent unexpected charges. This will help you manage Sumo Logic credits, especially in pay-per-use scenarios, by setting budgets on scan data volume.
10+
11+
## Throttling Limits
12+
13+
Throttling limits helps you to view the logs, traces, and traces ingestion rate with the throttling value. With [View Recent Breaches](/docs/manage/security/audit-indexes/audit-index/#throttling-events) button you can view recent throttling limit breaches.
14+
15+
## Availability
16+
17+
| Account Type | Account Level |
18+
|:--|:--|
19+
| Credits | Free, Trial, Essentials (Flex), Enterprise Operations (Flex), Enterprise Security (Flex), Enterprise Suite |
20+
21+
## Set query size limit
22+
23+
To manage the query size limit follow the below steps:
24+
25+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Administration > Account > Organization Usage Limits**. <br/> [**New UI**](/docs/get-started/sumo-logic-ui/). In the top menu, select **Administration**, and then under **Account**, select **Organization Usage Limits**. You can also click the **Go To...** menu at the top of the screen and select **Organization Usage Limits**. <br/><img src={useBaseUrl('/img/manage/account/organization-usage-limits.png')} alt="organization-usage-limits" style={{border:'1px solid gray'}} width="650"/>
26+
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.
27+
1. Click **Save Limit**.
28+
29+
:::info
30+
Sumo Logic defines scan as two types:
31+
- **Foreground interactive search**. Search page UI, Copilot, and Dashboards.
32+
- **Background search**. API, Scheduled Search, Monitor, Scheduled Views, and SLO.
33+
:::
34+
35+
:::note
36+
It may take up to 5 minutes for a newly created budget to become active and enforceable in the system.
37+
:::
38+
39+
The **Advanced** method for setting the budgets allows you to configure limits for individual users and helps admins assign roles for easier group selection. [Learn more](/docs/manage/manage-subscription/scan-budgets).

docs/manage/manage-subscription/usage-management.md renamed to docs/manage/manage-subscription/scan-budgets.md

Lines changed: 12 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,25 @@
11
---
2-
id: usage-management
3-
title: Usage Management
4-
description: Learn to set query level budget to define spending limits for queries.
2+
id: scan-budgets
3+
title: Scan Budget
4+
description: Learn to set advacned query limits to define spending limits for queries.
55
---
66

77
import useBaseUrl from '@docusaurus/useBaseUrl';
88

9-
This page provides information about the Scan Budgets, which allows you to define spending limits for queries to prevent unexpected charges. This will help you manage Sumo Logic credits, especially in pay-per-use scenarios, by setting budgets on scan data volume.
9+
Scan budget allows you to configure limits for individual users and helps admins assign roles for easier group selection. This method provides flexibility in your actions when the budget limit is reached.
1010

11-
Sumo Logic provides two modes with which you can set the query limits:
12-
- Basic
13-
- Advanced
14-
15-
## Basic
16-
17-
### Availability
18-
19-
| Account Type | Account Level |
20-
|:--------------|:--------------------------------------|
21-
| Credits | Free, Trial, Essentials (Flex), Enterprise Operations (Flex), Enterprise Security (Flex), Enterprise Suite |
22-
23-
### Set query size limit
24-
25-
To manage the query size limit using the **Basic** configuration:
26-
27-
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**. <br/><img src={useBaseUrl('/img/manage/account/usage-management.png')} alt="usage-management" style={{border:'1px solid gray'}} width="650"/>
28-
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.
29-
1. Click **Save Limit**.
30-
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, Scheduled Views, and SLO.
35-
:::
36-
37-
:::note
38-
It may take up to 5 minutes for a newly created budget to become active and enforceable in the system.
39-
:::
40-
41-
## Advanced
42-
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.
44-
45-
### Availability
11+
## Availability
4612

4713
| Account Type | Account Level |
48-
|:--------------|:--------------------------------------|
14+
|:--|:--|
4915
| Credits | Essentials (Flex) and Enterprise Suite |
5016

51-
### Set scan budgets
17+
## Set scan budgets
5218

5319
To create the query size limit using the **Advanced** configuration:
5420

55-
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**.
56-
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"/>
21+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Administration > Account > Scan Budget**. <br/> [**New UI**](/docs/get-started/sumo-logic-ui/). In the top menu, select **Administration**, and then under **Account**, select **Scan Budget**. You can also click the **Go To...** menu at the top of the screen and select **Scan Budget**.<br/><img src={useBaseUrl('/img/manage/account/scan-budget-advanced.png')} alt="scan-budget-advanced" style={{border:'1px solid gray'}} width="800"/>
22+
1. Click on the **+ Create Scan Budget**.
5723
1. **Scope**. Include or exclude the users and roles for whom the scan budget should apply.
5824
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.
5925
- **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.
@@ -78,12 +44,12 @@ To create the query size limit using the **Advanced** configuration:
7844
It may take up to 5 minutes for a newly created budget to become active and enforceable in the system.
7945
:::
8046

81-
### View details about a Scan Budget
47+
## View details about a Scan Budget
8248

8349
To view the selected scan budget:
8450

85-
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**.
86-
1. Navigate to **Advanced** tab and click the row with the scan budget you want to view.
51+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Administration > Account > Scan Budget**. <br/> [**New UI**](/docs/get-started/sumo-logic-ui/). In the top menu, select **Administration**, and then under **Account**, select **Scan Budget**. You can also click the **Go To...** menu at the top of the screen and select **Scan Budget**.
52+
1. Click the scan budget which you want to view.
8753
1. In the details section: <br/><img src={useBaseUrl('/img/manage/account/view-scan-budget.png')} alt="view-scan-budget" style={{border:'1px solid gray'}} width="400"/>
8854
- **Edit**. Click the **Edit** button to open the pane for editing. Edit the required fields and click on **Save**.
8955
:::note

docs/manage/manage-subscription/sumo-logic-flex-accounts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,8 @@ The following table provides a summary list of key features by Flex package acco
138138
| Sumo Logic Apps | &#10003; | &#10003; | &#10003; | &#10003; |
139139
| Support | &#10003; | &#10003; | &#10003; | &#10003; |
140140
| Traces | &#10003;<br/>Up to 1.5GB per day* | &#10003;<br/>Up to 5GB per day | &#10003;<br/>5GB per day| &#10003;<br/>Up to 5GB per day |
141-
| Usage Management - Advanced | | | | &#10003; |
142-
| Usage Management - Basic | &#10003; | &#10003; | | &#10003; |
141+
| Scan Budget | | | | &#10003; |
142+
| Organization Usage Limits | &#10003; | &#10003; | | &#10003; |
143143
| User and Role APIs | &#10003; | &#10003; | &#10003; | <br/>Up to 5GB per day |
144144
| War Room | | | | &#10003; |
145145

sidebars.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1004,7 +1004,8 @@ module.exports = {
10041004
],
10051005
},
10061006
'manage/manage-subscription/manage-billing-information',
1007-
'manage/manage-subscription/usage-management',
1007+
'manage/manage-subscription/organization-usage-limits',
1008+
'manage/manage-subscription/scan-budgets',
10081009
'manage/manage-subscription/fedramp-capabilities',
10091010
'manage/manage-subscription/beta-opt-in',
10101011
'manage/manage-subscription/close-cancel-sumo-account',
187 KB
Loading

0 commit comments

Comments
 (0)