From 57b13d4613aa2eb6059ce6a30bc25e607a808247 Mon Sep 17 00:00:00 2001 From: Jagadisha V <129049263+JV0812@users.noreply.github.com> Date: Mon, 27 Jan 2025 13:48:36 +0530 Subject: [PATCH 1/7] FAQs added with respect to Time phased budgets --- .../manage-subscription/usage-management.md | 24 +++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/docs/manage/manage-subscription/usage-management.md b/docs/manage/manage-subscription/usage-management.md index 34eee4d735..0e223718f7 100644 --- a/docs/manage/manage-subscription/usage-management.md +++ b/docs/manage/manage-subscription/usage-management.md @@ -58,6 +58,11 @@ To create the query size limit using the **Advanced** configuration: 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. - **Time-phased budgets**. Select **Daily**, **Weekly**, or **Monthly** from the **Budget Type** dropdown and enter the maximum amount of budget in GB. You can set a single shared budget for an entire group by selecting the **Capacity for the Group** option, whereas, you can set a budget for individual user in the selected scope by selecting the **Capacity per User** option. + :::note + - For **Daily** budgets, the capacity resets at midnight PST. + - For **Weekly** budgets, the capacity resets on Monday at 00:00 PST. + - For **Monthly** budgets, the capacity resets on the 1st day of every calendar month at 00:00 PST. + ::: 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. This will block the foreground searches but will not impact any background searches/automated queries. @@ -88,7 +93,7 @@ To view 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: Query level or time-phased budgets. - - **Per Query Budget**. Limits the data (in GBs) that a single query can consume. + - **Per Query Budget**. Limits the data (in GBs) that a single query can consume. If the query size exceeds the set limit, you will not be able to continue scanning until they are within the query size limit. - **Time phased budgets**. Limits the data (in GBs) that a single user or a group can consume based on the time phase selected while creating the budget. - **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**. @@ -101,7 +106,7 @@ To view the selected 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 +## FAQs ### Handle overlapping budgets @@ -110,3 +115,18 @@ When you configure multiple budgets for the same user, the scope with the larges ### Exceeding the scan budget When you perform a log search, if the results exceed the specified capacity limit, an error message will be displayed with no results. For example, consider you set a budget of 1 GB/query, and when your log search results exceed the set budget limit, an error message will be displayed as shown below.
exceed-scan-budget-warning + +## Update the budget time window, applied on, capacity, or action + +- Changing the time window (for example, from Daily to Weekly) resets budget usage, and the new configuration is applied immediately. +- Adjusting the **Applied on** setting (for example, from Capacity for the Group to Capacity per User) resets budget usage, with the updated configuration taking effect immediately. +- Updating the budget **Capacity** (for example, from 10GB to 20GB) applies the new limit instantly, with error and warning messages reflecting the changes. +- Modifying the budget **Action** (for example, from StopForegroundScan to Warn) updates the system behavior immediately, issuing a warning message when the new threshold is breached. + +## Manage new user addition to an existing budget + +If you are added to an existing budget as a new user, your usage will draw from the remaining capacity, aligned with the updated configuration and the specified limits for your role. + +## Handling budgets in relation to each other + +Each budget type (daily, weekly, monthly, or query) is treated independently, without conflicts between them. Usage is evaluated based on the maximum capacity defined for each budget type. For example, if the daily budget is exceeded and a Stop action is triggered, the user will be blocked from scanning until the daily budget resets, regardless of any remaining capacity in the monthly budget. \ No newline at end of file From 91fdc9c844c437eb14c6439a6d2e20305ca2af17 Mon Sep 17 00:00:00 2001 From: Jagadisha V <129049263+JV0812@users.noreply.github.com> Date: Mon, 27 Jan 2025 15:40:44 +0530 Subject: [PATCH 2/7] Update docs/manage/manage-subscription/usage-management.md Co-authored-by: Kim (Sumo Logic) <56411016+kimsauce@users.noreply.github.com> --- docs/manage/manage-subscription/usage-management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manage/manage-subscription/usage-management.md b/docs/manage/manage-subscription/usage-management.md index 0e223718f7..0299acdc71 100644 --- a/docs/manage/manage-subscription/usage-management.md +++ b/docs/manage/manage-subscription/usage-management.md @@ -59,7 +59,7 @@ To create the query size limit using the **Advanced** configuration: - **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. - **Time-phased budgets**. Select **Daily**, **Weekly**, or **Monthly** from the **Budget Type** dropdown and enter the maximum amount of budget in GB. You can set a single shared budget for an entire group by selecting the **Capacity for the Group** option, whereas, you can set a budget for individual user in the selected scope by selecting the **Capacity per User** option. :::note - - For **Daily** budgets, the capacity resets at midnight PST. + - For **Daily** budgets, the capacity resets every day at midnight (00:00 PST). - For **Weekly** budgets, the capacity resets on Monday at 00:00 PST. - For **Monthly** budgets, the capacity resets on the 1st day of every calendar month at 00:00 PST. ::: From 635d9b9e335266abcf11028ed2683081e4803267 Mon Sep 17 00:00:00 2001 From: Jagadisha V <129049263+JV0812@users.noreply.github.com> Date: Mon, 27 Jan 2025 15:40:54 +0530 Subject: [PATCH 3/7] Update docs/manage/manage-subscription/usage-management.md Co-authored-by: Kim (Sumo Logic) <56411016+kimsauce@users.noreply.github.com> --- docs/manage/manage-subscription/usage-management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manage/manage-subscription/usage-management.md b/docs/manage/manage-subscription/usage-management.md index 0299acdc71..d387a1e5b1 100644 --- a/docs/manage/manage-subscription/usage-management.md +++ b/docs/manage/manage-subscription/usage-management.md @@ -61,7 +61,7 @@ To create the query size limit using the **Advanced** configuration: :::note - For **Daily** budgets, the capacity resets every day at midnight (00:00 PST). - For **Weekly** budgets, the capacity resets on Monday at 00:00 PST. - - For **Monthly** budgets, the capacity resets on the 1st day of every calendar month at 00:00 PST. + - For **Monthly** budgets, the capacity resets on the first day of each calendar month at 00:00 PST. ::: 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. From 9bd438aef28dd01841d0ed401372bf16b288333c Mon Sep 17 00:00:00 2001 From: Jagadisha V <129049263+JV0812@users.noreply.github.com> Date: Mon, 27 Jan 2025 15:41:03 +0530 Subject: [PATCH 4/7] Update docs/manage/manage-subscription/usage-management.md Co-authored-by: Kim (Sumo Logic) <56411016+kimsauce@users.noreply.github.com> --- docs/manage/manage-subscription/usage-management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manage/manage-subscription/usage-management.md b/docs/manage/manage-subscription/usage-management.md index d387a1e5b1..82345803ca 100644 --- a/docs/manage/manage-subscription/usage-management.md +++ b/docs/manage/manage-subscription/usage-management.md @@ -60,7 +60,7 @@ To create the query size limit using the **Advanced** configuration: - **Time-phased budgets**. Select **Daily**, **Weekly**, or **Monthly** from the **Budget Type** dropdown and enter the maximum amount of budget in GB. You can set a single shared budget for an entire group by selecting the **Capacity for the Group** option, whereas, you can set a budget for individual user in the selected scope by selecting the **Capacity per User** option. :::note - For **Daily** budgets, the capacity resets every day at midnight (00:00 PST). - - For **Weekly** budgets, the capacity resets on Monday at 00:00 PST. + - For **Weekly** budgets, the capacity resets each Monday at 00:00 PST. - For **Monthly** budgets, the capacity resets on the first day of each calendar month at 00:00 PST. ::: 1. **Action**. Select the type of action/response you require when the budget limit is reached. From a12e7de040002e4da23747065bc477d1fe341341 Mon Sep 17 00:00:00 2001 From: Jagadisha V <129049263+JV0812@users.noreply.github.com> Date: Wed, 5 Feb 2025 17:15:20 +0530 Subject: [PATCH 5/7] added new FAQ --- .../manage-subscription/usage-management.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/manage/manage-subscription/usage-management.md b/docs/manage/manage-subscription/usage-management.md index 82345803ca..80e40e12f8 100644 --- a/docs/manage/manage-subscription/usage-management.md +++ b/docs/manage/manage-subscription/usage-management.md @@ -108,7 +108,7 @@ To view the selected scan budget: ## FAQs -### Handle overlapping budgets +### Handling overlapping budgets When you configure multiple budgets for the same user, the scope with the largest capacity takes precedence. However, if the budgets are of same values (for example, Budget A and Budget B are of same value 10 GB) then the most restrictive budget takes precedence. @@ -116,17 +116,23 @@ When you configure multiple budgets for the same user, the scope with the larges When you perform a log search, if the results exceed the specified capacity limit, an error message will be displayed with no results. For example, consider you set a budget of 1 GB/query, and when your log search results exceed the set budget limit, an error message will be displayed as shown below.
exceed-scan-budget-warning -## Update the budget time window, applied on, capacity, or action +### Update the budget time window, applied on, capacity, or action - Changing the time window (for example, from Daily to Weekly) resets budget usage, and the new configuration is applied immediately. - Adjusting the **Applied on** setting (for example, from Capacity for the Group to Capacity per User) resets budget usage, with the updated configuration taking effect immediately. - Updating the budget **Capacity** (for example, from 10GB to 20GB) applies the new limit instantly, with error and warning messages reflecting the changes. - Modifying the budget **Action** (for example, from StopForegroundScan to Warn) updates the system behavior immediately, issuing a warning message when the new threshold is breached. -## Manage new user addition to an existing budget +### Manage new user addition to an existing budget If you are added to an existing budget as a new user, your usage will draw from the remaining capacity, aligned with the updated configuration and the specified limits for your role. -## Handling budgets in relation to each other +### Breaching the query size limit + +Each budget type (daily, weekly, monthly, or query) is treated independently, without conflicts between them. Usage is evaluated based on the maximum capacity defined for each budget type. For example, if the daily budget is exceeded and a Stop action is triggered, the user will be blocked from scanning until the daily budget resets, regardless of any remaining capacity in the monthly budget. + +### Usage attribution across multiple budget types + +As long as you are within the limits of each budget type, usage will be attributed independently to each budget type. If you exceed any one budget type, the action for that budget will be applied. But usage will still be reported to other budgets if they have available capacity. For example, if the daily limit and monthly limit is set to 100GB and 300GB respectively, and if you have used 50 GB of your daily limit, then this usage will be reported to both the daily and monthly budgets as long as they are within their capacity. The query budget only tracks the size in GB per query, so the user will still be within the query budget if the query size limit is not breached. + -Each budget type (daily, weekly, monthly, or query) is treated independently, without conflicts between them. Usage is evaluated based on the maximum capacity defined for each budget type. For example, if the daily budget is exceeded and a Stop action is triggered, the user will be blocked from scanning until the daily budget resets, regardless of any remaining capacity in the monthly budget. \ No newline at end of file From 16bfb3e5610d2d385ed936e80bd0b618628e6fe4 Mon Sep 17 00:00:00 2001 From: Jagadisha V <129049263+JV0812@users.noreply.github.com> Date: Thu, 6 Feb 2025 10:59:12 +0530 Subject: [PATCH 6/7] Update docs/manage/manage-subscription/usage-management.md --- docs/manage/manage-subscription/usage-management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manage/manage-subscription/usage-management.md b/docs/manage/manage-subscription/usage-management.md index 80e40e12f8..0610a4c21b 100644 --- a/docs/manage/manage-subscription/usage-management.md +++ b/docs/manage/manage-subscription/usage-management.md @@ -112,7 +112,7 @@ To view the selected scan budget: When you configure multiple budgets for the same user, the scope with the largest capacity takes precedence. However, if the budgets are of same values (for example, Budget A and Budget B are of same value 10 GB) then the most restrictive budget takes precedence. -### Exceeding the scan budget +### Exceeding the scan budget query limit When you perform a log search, if the results exceed the specified capacity limit, an error message will be displayed with no results. For example, consider you set a budget of 1 GB/query, and when your log search results exceed the set budget limit, an error message will be displayed as shown below.
exceed-scan-budget-warning From 7f71780df0a47c943aa977b4b484b95a21b1a93c Mon Sep 17 00:00:00 2001 From: Jagadisha V <129049263+JV0812@users.noreply.github.com> Date: Thu, 6 Feb 2025 10:59:19 +0530 Subject: [PATCH 7/7] Update docs/manage/manage-subscription/usage-management.md --- docs/manage/manage-subscription/usage-management.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manage/manage-subscription/usage-management.md b/docs/manage/manage-subscription/usage-management.md index 0610a4c21b..0e588d2c55 100644 --- a/docs/manage/manage-subscription/usage-management.md +++ b/docs/manage/manage-subscription/usage-management.md @@ -114,7 +114,7 @@ When you configure multiple budgets for the same user, the scope with the larges ### Exceeding the scan budget query limit -When you perform a log search, if the results exceed the specified capacity limit, an error message will be displayed with no results. For example, consider you set a budget of 1 GB/query, and when your log search results exceed the set budget limit, an error message will be displayed as shown below.
exceed-scan-budget-warning +When you perform a log search, if the results exceed the specified query limit, an error message will be displayed with no results. For example, consider you set a budget of 1 GB/query, and when your log search results exceed the set budget limit, an error message will be displayed as shown below.
exceed-scan-budget-warning ### Update the budget time window, applied on, capacity, or action