|
1 | 1 | --- |
2 | 2 | id: usage-management |
3 | | -title: Usage Management (Beta) |
| 3 | +title: Usage Management |
4 | 4 | description: Learn to set query level budget to define spending limits for queries. |
5 | 5 | --- |
6 | 6 |
|
7 | | -<head> |
8 | | - <meta name="robots" content="noindex" /> |
9 | | -</head> |
10 | | - |
11 | 7 | import useBaseUrl from '@docusaurus/useBaseUrl'; |
12 | 8 |
|
13 | | -<p><a href="/docs/beta"><span className="beta">Closed Beta</span></a></p> |
14 | | - |
15 | 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. |
16 | 10 |
|
17 | | -To manage the query size limit: |
| 11 | +Sumo Logic provides two ways with which you can set the query limits: |
| 12 | +- Basic |
| 13 | +- Advanced |
| 14 | + |
| 15 | +## Basic |
| 16 | + |
| 17 | +To manage the query size limit using **Basic** configuration: |
18 | 18 |
|
19 | 19 | 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"/> |
20 | | -1. You will have two options to manage the query size limit: |
21 | | - - **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. |
22 | | - - **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"/> |
| 20 | +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. However, if you run an unoptimized query, excessive data will be scanned and accordingly the scan cost will be increased. |
23 | 21 | 1. Click **Save Limit**. |
24 | 22 |
|
25 | 23 | :::note |
26 | 24 | It may take up to 5 minutes for a newly created budget to become active and enforceable in the system. |
27 | 25 | ::: |
28 | 26 |
|
29 | | -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. |
| 27 | +## Advanced |
| 28 | + |
| 29 | +To create the query size limit using **Advanced** configuration: |
| 30 | + |
| 31 | +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**. |
| 32 | +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"/> |
| 33 | +1. **Scope**. Include or exclude the users and roles for whom the scan budget should apply. |
| 34 | +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. |
| 35 | +1. **Action**. Select the type of action/response you require when the budget limit is reached. |
| 36 | + - **Show Warning to the user**. Query result will be displayed with a the error message. |
| 37 | + - **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. |
| 38 | +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"/> |
| 39 | +1. Click **Save** to create the scan budget. |
| 40 | + |
| 41 | +:::note |
| 42 | +It may take up to 5 minutes for a newly created budget to become active and enforceable in the system. |
| 43 | +::: |
| 44 | + |
| 45 | +### View deatails about a Scan Budgets |
30 | 46 |
|
31 | | -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. |
| 47 | +To view the selected scan budget: |
32 | 48 |
|
33 | | -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"/> |
| 49 | +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**. |
| 50 | +1. Navigate to **Advanced** tab and click the row with the scan budget you want to view. |
| 51 | +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"/> |
| 52 | + - **Edit**. Click the **Edit** button to open the pane for editing. Edit the query limit and click on **Save**. |
| 53 | + :::note |
| 54 | + You cannot edit the Scope, Action, and Details information. |
| 55 | + ::: |
| 56 | + - **Deactivate/Activate**. Click the **Deactivate/Activate** button to deactivate/activate the selected scan budget. |
| 57 | + - **Delete**. Click the **Delete** button to delete the selected scan budget. |
| 58 | + - **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. |
| 59 | + - **Budget Type**. |
| 60 | + - **Status**. Describes if the scan budget is active or inactive. |
| 61 | + - **Usage Category**. |
| 62 | + - **Applied to Roles**. Describes the roles for which the selected scan budget is applied for. |
| 63 | + - **Excluded to Roles**. Describes the roles for which the selected scan budget is excluded for. |
| 64 | + - **Applied to Users**. Describes the users for which the selected scan budget is applied for. |
| 65 | + - **Excluded to Roles**. Describes the users for which the selected scan budget is excluded for. |
| 66 | + - **Budget Capacity for individual user**. Describes the budget set for individual user search. |
| 67 | + - **Action**. Describes the type of action sected to notify when the budget limit is reached. |
| 68 | + - **Created**. The user who created the scan budget. |
| 69 | + - **Modified**. The user that most recently modified the scan budget. |
| 70 | + - **Audit Logs**. |
| 71 | + - **System Audit**. |
0 commit comments