Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions blog-service/2024/12-31.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,15 +331,15 @@ Minor *query* fixes in the below [Classic Apps (Legacy)](/docs/get-started/apps-

#### Scan Budgets

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.
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.

Key features include:

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

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

### October 29, 2024 (Apps)

Expand Down
4 changes: 1 addition & 3 deletions blog-service/2025-01-23-manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,4 @@ hide_table_of_contents: true

import useBaseUrl from '@docusaurus/useBaseUrl';



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).
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).
3 changes: 2 additions & 1 deletion cid-redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -2461,7 +2461,8 @@
"/cid/5238": "/docs/send-data/collection/processing-rules/mask-rules",
"/cid/5239": "/docs/search/search-query-language/search-operators/matches",
"/cid/524": "/docs/manage/manage-subscription/cloud-flex-legacy-accounts",
"/cid/5355": "/docs/manage/manage-subscription/usage-management",
"/cid/5355": "/docs/manage/manage-subscription/organization-usage-limits",
"/cid/5366": "/docs/manage/manage-subscription/scan-budgets",
"/cid/5241": "/docs/metrics/metrics-operators/max",
"/cid/5244": "/docs/metrics/metrics-operators/min",
"/cid/5245": "/docs/search/get-started-with-search/search-page/modify-search-from-messages-tab",
Expand Down
10 changes: 5 additions & 5 deletions docs/api/scan-budget.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import ApiRoles from '../reuse/api-roles.md';

<img src={useBaseUrl('img/icons/operations/data-volume.png')} alt="Thumbnail icon" width="50"/>

The Scan Budget Management APIs allows you to manage scan budgets from HTTP endpoints. Scan budgets apply to all chargeable log scan queries. For more information, refer to [Scan Budgets](/docs/manage/manage-subscription/usage-management).
The Scan Budget Management APIs allows you to manage scan budgets from HTTP endpoints. Scan budgets apply to all chargeable log scan queries. For more information, refer to [Scan Budget](/docs/manage/manage-subscription/scan-budgets).

## Prerequisites

Expand Down Expand Up @@ -38,8 +38,8 @@ The Scan Budget Management APIs allows you to manage scan budgets from HTTP endp

<ApiRoles/>

* Usage Management
* View Usage Management
* Manage Usage Management
* Scan Budget
* View Scan Budget
* Manage Scan Budget

To manage scan budgets, you must have the **Manage Usage Management** role capability. Enabling this will also automatically enable the **View Usage Management** capability.
To manage scan budgets, you must have the **Manage Scan Budget** role capability. Enabling this will also automatically enable the **View Scan Budget** capability.
8 changes: 7 additions & 1 deletion docs/manage/manage-subscription/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,16 @@ In this section, we'll introduce the following concepts:
</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>
<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>
<p>Learn to set query-level budget to define spending limits for queries.</p>
</div>
</div>
<div className="box smallbox card">
<div className="container">
<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>
<p>Learn to set advacned query-level budget to define spending limits for queries.</p>
</div>
</div>
<div className="box smallbox card">
<div className="container">
<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>
Expand Down
43 changes: 43 additions & 0 deletions docs/manage/manage-subscription/organization-usage-limits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
id: organization-usage-limits
title: Organization Usage Limits
description: Learn to set query level budget to define spending limits for queries.
---

import useBaseUrl from '@docusaurus/useBaseUrl';

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.

## Ingestion - Throttling Limits

:::info
Only **Administrators** have the access to view the **Ingestion - Throttling Limits** section.
:::

This section provides information about the baseline and throttling limits set. Click **View Usage and Throttling Limits** button to view the logs, traces, and traces ingestion rate over the selected time range. With [View Recent Breaches](/docs/manage/security/audit-indexes/audit-index/#throttling-events) button you can view recent throttling limit breaches.

## Availability

| Account Type | Account Level |
|:--|:--|
| Credits | Free, Trial, Essentials (Flex), Enterprise Operations (Flex), Enterprise Security (Flex), Enterprise Suite |

## Set query size limit

To manage the query size limit follow the below steps:

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"/>
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.
1. Click **Save Limit**.

:::info
Sumo Logic defines scan as two types:
- **Foreground interactive search**. Search page UI, Copilot, and Dashboards.
- **Background search**. API, Scheduled Search, Monitor, Scheduled Views, and SLO.
:::

:::note
It may take up to 5 minutes for a newly created budget to become active and enforceable in the system.
:::

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).
Original file line number Diff line number Diff line change
@@ -1,59 +1,25 @@
---
id: usage-management
title: Usage Management
description: Learn to set query level budget to define spending limits for queries.
id: scan-budgets
title: Scan Budget
description: Learn to set advacned query limits to define spending limits for queries.
---

import useBaseUrl from '@docusaurus/useBaseUrl';

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.
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.

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

## Basic

### Availability

| Account Type | Account Level |
|:--------------|:--------------------------------------|
| Credits | Free, Trial, Essentials (Flex), Enterprise Operations (Flex), Enterprise Security (Flex), Enterprise Suite |

### Set query size limit

To manage the query size limit using the **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. **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.
1. Click **Save Limit**.

:::info
Sumo Logic defines scan as two types:
- **Foreground interactive search**. Search page UI, Copilot, and Dashboards.
- **Background search**. API, Scheduled Search, Monitor, Scheduled Views, and SLO.
:::

:::note
It may take up to 5 minutes for a newly created budget to become active and enforceable in the system.
:::

## Advanced

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
## Availability

| Account Type | Account Level |
|:--------------|:--------------------------------------|
|:--|:--|
| Credits | Essentials (Flex) and Enterprise Suite |

### Set scan budgets
## 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**. <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. [**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"/>
1. Click on the **+ Create Scan Budget**.
1. **Scope**. Include or exclude the users and roles for whom the scan budget should apply.
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.
Expand All @@ -78,12 +44,12 @@ To create the query size limit using the **Advanced** configuration:
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 Budget
## View details about a scan budget

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. [**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**.
1. Click the scan budget which 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
Expand Down
4 changes: 2 additions & 2 deletions docs/manage/manage-subscription/sumo-logic-flex-accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,8 @@ The following table provides a summary list of key features by Flex package acco
| Sumo Logic Apps | &#10003; | &#10003; | &#10003; | &#10003; |
| Support | &#10003; | &#10003; | &#10003; | &#10003; |
| 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 |
| Usage Management - Advanced | | | | &#10003; |
| Usage Management - Basic | &#10003; | &#10003; | | &#10003; |
| Scan Budget | | | | &#10003; |
| Organization Usage Limits | &#10003; | &#10003; | | &#10003; |
| User and Role APIs | &#10003; | &#10003; | &#10003; | <br/>Up to 5GB per day |
| War Room | | | | &#10003; |

Expand Down
3 changes: 2 additions & 1 deletion sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1004,7 +1004,8 @@ module.exports = {
],
},
'manage/manage-subscription/manage-billing-information',
'manage/manage-subscription/usage-management',
'manage/manage-subscription/organization-usage-limits',
'manage/manage-subscription/scan-budgets',
'manage/manage-subscription/fedramp-capabilities',
'manage/manage-subscription/beta-opt-in',
'manage/manage-subscription/close-cancel-sumo-account',
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 not shown.
Binary file removed static/img/manage/account/usage-management.png
Binary file not shown.