Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
fbeb95f
Usage management - Advanced tab information added
JV0812 Oct 11, 2024
6ccb0a8
Minor content fix
JV0812 Oct 14, 2024
66672c4
Update usage-management.md
JV0812 Oct 14, 2024
542d969
Content updated
JV0812 Oct 16, 2024
afff441
Update docs/manage/manage-subscription/usage-management.md
JV0812 Oct 16, 2024
fbe0520
Update docs/manage/manage-subscription/usage-management.md
JV0812 Oct 16, 2024
41bbf79
Update docs/manage/manage-subscription/usage-management.md
JV0812 Oct 16, 2024
8538c78
masked the image
JV0812 Oct 16, 2024
c8debf1
Merge branch 'update-usage-management-doc' of https://github.com/Sumo…
JV0812 Oct 16, 2024
7fb3aae
Update blog-service/2024-10-18-manage.md
JV0812 Oct 16, 2024
8233982
Update blog-service/2024-10-18-manage.md
JV0812 Oct 18, 2024
8ac2d00
Update docs/manage/manage-subscription/usage-management.md
JV0812 Oct 18, 2024
4e4f220
Update docs/manage/manage-subscription/usage-management.md
JV0812 Oct 18, 2024
68c0fde
Update docs/manage/manage-subscription/index.md
JV0812 Oct 18, 2024
3559c54
Update docs/manage/manage-subscription/usage-management.md
JV0812 Oct 18, 2024
bf653d0
Update docs/manage/manage-subscription/usage-management.md
JV0812 Oct 18, 2024
c135585
Update docs/manage/manage-subscription/usage-management.md
JV0812 Oct 18, 2024
b79897e
Update docs/manage/manage-subscription/usage-management.md
JV0812 Oct 18, 2024
4d3efd5
Update docs/manage/manage-subscription/usage-management.md
JV0812 Oct 18, 2024
ebcff69
screenshots updated
JV0812 Oct 18, 2024
3849f35
Rename 2024-10-18-manage.md to 2024-10-22-manage.md
JV0812 Oct 21, 2024
b7db200
api docs added
JV0812 Oct 24, 2024
9eb08f9
added Scan Budgets Management APIs doc
JV0812 Oct 24, 2024
fe477c5
Update docs/api/scan-budget.md
JV0812 Oct 24, 2024
b209a20
Update scan-budget.md
JV0812 Oct 24, 2024
1893a14
Merge branch 'main' into update-usage-management-doc
jpipkin1 Oct 24, 2024
7733b56
Rename 2024-10-22-manage.md to 2024-10-25-manage.md
JV0812 Oct 25, 2024
bb33cfe
Merge branch 'main' into update-usage-management-doc
JV0812 Oct 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/manage/manage-subscription/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,10 @@ In this section, we'll introduce the following concepts:
<p>Learn the capabilities included with Sumo Logic’s FedRAMP solution.</p>
</div>
</div>
<div className="box smallbox card">
<div className="container">
<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>
<p>Learn to set query level budget to define spending limits for queries.</p>
</div>
</div>
</div>
75 changes: 61 additions & 14 deletions docs/manage/manage-subscription/usage-management.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,80 @@
---
id: usage-management
title: Usage Management (Beta)
title: Usage Management
description: Learn to set query level budget to define spending limits for queries.
---

<head>
<meta name="robots" content="noindex" />
</head>

import useBaseUrl from '@docusaurus/useBaseUrl';

<p><a href="/docs/beta"><span className="beta">Closed Beta</span></a></p>

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.

To manage the query size limit:
Sumo Logic provides two modes with which you can set the query limits:
- Basic
- Advanced

## Basic

To manage the query size limit using **Basic** configuration:

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"/>
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.<br/><img src={useBaseUrl('/img/manage/account/usage-management-click-here.png')} alt="usage-management-click-here" style={{border:'1px solid gray'}} width="300"/>
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.
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

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 create the query size limit using **Advanced** configuration:

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.<br/><img src={useBaseUrl('/img/manage/account/usage-management-warning.png')} alt="usage-management-warning" style={{border:'1px solid grey'}} width="700"/>
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**.
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"/>
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.<br/><img src={useBaseUrl('/img/manage/account/create-scan-budget.png')} alt="create-scan-budget" style={{border:'1px solid gray'}} width="650"/>
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 details about a Scan Budgets

To view the selected scan budget:

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**.
1. Navigate to **Advanced** tab and click the row with the scan budget you want to view.
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"/>
- **Edit**. Click the **Edit** button to open the pane for editing. Edit the required fields and click on **Save**.
:::note
You can only edit the **Capacity** for *Org-wide Query Budget* set using Basic.
:::
- **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: **Per Query Budget** or **Time-Based Budgets**(TBA).
- **Per Query Budget**. Limits the data (in GBs) that a single query can consume.
- **Time-Based Budgets**(TBA). Limits the data or credits consumed over a day, week, or month.
- **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.
- **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.
- **System Audit**. Records the breaches and budget enforcement. Click on **View Details** to view the list of breaches.


## FAQ

### Handle overlapping 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.
1 change: 1 addition & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
]
},
{
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/manage/account/usage-management.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading