diff --git a/blog-service/2024/12-31.md b/blog-service/2024/12-31.md index ec4503e6ce..0793b0c61b 100644 --- a/blog-service/2024/12-31.md +++ b/blog-service/2024/12-31.md @@ -331,7 +331,7 @@ 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: @@ -339,7 +339,7 @@ Key features include: - **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) diff --git a/blog-service/2025-01-23-manage.md b/blog-service/2025-01-23-manage.md index 675a71aa64..c0f435679c 100644 --- a/blog-service/2025-01-23-manage.md +++ b/blog-service/2025-01-23-manage.md @@ -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). \ No newline at end of file +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). \ No newline at end of file diff --git a/blog-service/2025-10-08-manage.md b/blog-service/2025-10-08-manage.md new file mode 100644 index 0000000000..b18343a7d3 --- /dev/null +++ b/blog-service/2025-10-08-manage.md @@ -0,0 +1,11 @@ +--- +title: Ingestion Throttling Limits (Manage) +image: https://help.sumologic.com/img/reuse/rss-image.jpg +keywords: + - ingestion-throttling + - manage + - throttling-notification +hide_table_of_contents: true +--- + +We’re excited to announce the new **Organization Usage Limits** tab, featuring the **Ingestion – Throttling Limits** section. This section displays your average ingestion rate for a selected time range alongside your account’s throttling limits. Additionally, you can opt in to receive email notifications whenever your account experiences throttling. [Learn more](/docs/manage/manage-subscription/organization-usage-limits). \ No newline at end of file diff --git a/cid-redirects.json b/cid-redirects.json index 71378ba266..6903d77b9f 100644 --- a/cid-redirects.json +++ b/cid-redirects.json @@ -2475,7 +2475,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", diff --git a/docs/api/scan-budget.md b/docs/api/scan-budget.md index d05b902a6b..e3080adfbc 100644 --- a/docs/api/scan-budget.md +++ b/docs/api/scan-budget.md @@ -10,7 +10,7 @@ import ApiRoles from '../reuse/api-roles.md'; Thumbnail icon -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 diff --git a/docs/manage/manage-subscription/index.md b/docs/manage/manage-subscription/index.md index 0a18cae789..7a05872a34 100644 --- a/docs/manage/manage-subscription/index.md +++ b/docs/manage/manage-subscription/index.md @@ -49,10 +49,16 @@ In this section, we'll introduce the following concepts:
- icon

Usage Management

+ icon

Organization Usage Limits

Learn to set query-level budget to define spending limits for queries.

+
+
+ icon

Scan Budget

+

Learn to set advacned query-level budget to define spending limits for queries.

+
+
icon

FedRAMP Capabilities

diff --git a/docs/manage/manage-subscription/organization-usage-limits.md b/docs/manage/manage-subscription/organization-usage-limits.md new file mode 100644 index 0000000000..970ddec1bc --- /dev/null +++ b/docs/manage/manage-subscription/organization-usage-limits.md @@ -0,0 +1,53 @@ +--- +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 **Administrator** 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, metrics, 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. + +### Enable Ingestion Throttling Notifications + +:::note +Only users with **Administrator** access can enable this feature. +::: + +1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select your username and then **Preferences**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu, select the person silhouette icon and then **Preferences**.
Account Preferences +1. Access your [Preferences](/docs/get-started/account-settings-preferences/#my-preferences). +1. Navigate to **My Preferences** and uncheck the **Enable ingestion throttling notifications** checkbox.
enable-ingestion-throttling-notifications + +## 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**.
[**New UI**](/docs/get-started/sumo-logic-ui/). In the Sumo Logic main 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**.
organization-usage-limits +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). diff --git a/docs/manage/manage-subscription/usage-management.md b/docs/manage/manage-subscription/scan-budgets.md similarity index 67% rename from docs/manage/manage-subscription/usage-management.md rename to docs/manage/manage-subscription/scan-budgets.md index 22c9665a3e..3560fd28d7 100644 --- a/docs/manage/manage-subscription/usage-management.md +++ b/docs/manage/manage-subscription/scan-budgets.md @@ -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 advanced 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. [**New UI**](/docs/get-started/sumo-logic-ui/). In the main Sumo Logic 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**.
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Administration > Account > Usage Management**.
usage-management -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. [**New UI**](/docs/get-started/sumo-logic-ui/). In the main Sumo Logic 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**.
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Administration > Account > Usage Management**. -1. Navigate to **Advanced** tab and click on **+ Create Scan Budget**.
usage-management +1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Administration > Account > Scan Budget**.
[**New UI**](/docs/get-started/sumo-logic-ui/). In the Sumo Logic main 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**.
scan-budget-advanced +1. Click **+ 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. @@ -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. [**New UI**](/docs/get-started/sumo-logic-ui/). In the main Sumo Logic 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**.
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Administration > Account > 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**.
[**New UI**](/docs/get-started/sumo-logic-ui/). In the Sumo Logic main 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 that you want to view. 1. In the details section:
view-scan-budget - **Edit**. Click the **Edit** button to open the pane for editing. Edit the required fields and click on **Save**. :::note diff --git a/docs/manage/manage-subscription/sumo-logic-flex-accounts.md b/docs/manage/manage-subscription/sumo-logic-flex-accounts.md index 25b83a7128..f601c6cbef 100644 --- a/docs/manage/manage-subscription/sumo-logic-flex-accounts.md +++ b/docs/manage/manage-subscription/sumo-logic-flex-accounts.md @@ -134,8 +134,8 @@ The following table provides a summary list of key features by Flex package acco | Sumo Logic Apps | ✓ | ✓ | ✓ | ✓ | | Support | ✓ | ✓ | ✓ | ✓ | | Traces | ✓
Up to 1.5GB per day* | ✓
Up to 5GB per day | ✓
5GB per day| ✓
Up to 5GB per day | -| Usage Management - Advanced | | | | ✓ | -| Usage Management - Basic | ✓ | ✓ | | ✓ | +| Scan Budget | | | | ✓ | +| Organization Usage Limits | ✓ | ✓ | | ✓ | | User and Role APIs | ✓ | ✓ | ✓ |
Up to 5GB per day | | War Room | | | | ✓ | diff --git a/sidebars.ts b/sidebars.ts index faa14cc9f2..6f12ff2454 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -1008,7 +1008,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', diff --git a/static/img/get-started/enable-ingestion-throttling-notifications.png b/static/img/get-started/enable-ingestion-throttling-notifications.png new file mode 100644 index 0000000000..764a87b010 Binary files /dev/null and b/static/img/get-started/enable-ingestion-throttling-notifications.png differ diff --git a/static/img/manage/account/organization-usage-limits.png b/static/img/manage/account/organization-usage-limits.png new file mode 100644 index 0000000000..9642f1e574 Binary files /dev/null and b/static/img/manage/account/organization-usage-limits.png differ diff --git a/static/img/manage/account/scan-budget-advanced.png b/static/img/manage/account/scan-budget-advanced.png new file mode 100644 index 0000000000..57c15129b1 Binary files /dev/null and b/static/img/manage/account/scan-budget-advanced.png differ diff --git a/static/img/manage/account/usage-management-advanced.png b/static/img/manage/account/usage-management-advanced.png deleted file mode 100644 index 14009784c1..0000000000 Binary files a/static/img/manage/account/usage-management-advanced.png and /dev/null differ diff --git a/static/img/manage/account/usage-management.png b/static/img/manage/account/usage-management.png deleted file mode 100644 index 8a489c5ac7..0000000000 Binary files a/static/img/manage/account/usage-management.png and /dev/null differ