Usage Management
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.
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:
- Classic UI. In the main Sumo Logic menu, select Administration > Account > Usage Management.
New 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. - 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.
- Click Save Limit.
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.
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 query size limits 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​
Account Type | Account Level |
---|---|
Credits | Essentials (Flex) and Enterprise Suite |
Set query size limit​
To create the query size limit using the Advanced configuration:
- Classic UI. In the main Sumo Logic menu, select Administration > Account > Usage Management.
New 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. - Navigate to Advanced tab and click on + Create Scan Budget.
- Scope. Include or exclude the users and roles for whom the scan budget should apply.
- Capacity. 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 the Click here button to help you determine the appropriate size limit.
- 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.
infoSumo Logic defines scan as two types:
- Foreground interactive search. Search page UI, Copilot, and Dashboards.
- Background search. API, Scheduled Search, Monitors, Scheduled Views, and SLO.
- Details. Enter the name for the scan budget.
- Click Save to create the scan budget.
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​
To view the selected scan budget:
- Classic UI. In the main Sumo Logic menu, select Administration > Account > Usage Management.
New 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. - Navigate to Advanced tab and click the row with the scan budget you want to view.
- In the details section:
- 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. Limits the data (in GBs) that a single query can consume.
- 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. 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.