The Search Audit Index provides event logs on search usage and activities for your account. The index allows you to monitor and audit the search queries being run within your account, the types of queries, the users running them, and more.
To visualize your Search Audit Index data, download the Enterprise Search Audit App, which provides pre-built dashboards and reports to help you analyze your current search use and identify areas for improvement.
This feature is available in the following account plans.
|Account Type||Account Level|
|Cloud Flex||Trial, Enterprise|
|Cloud Flex Credits||Trial, Enterprise Operations, Enterprise Security, Enterprise Suite|
Enable the Search Audit Index
The Search Audit Index must be enabled by an administrator.
To enable the Search Audit Index:
Go to the Administration > Security > Policies page.
Under Sumo Logic Auditing, select the second Enable option.
- Users with a role that grants the Manage audit data feed capability are allowed to enable the Search Audit Index.
- Enabling the index will not count towards your data volume quota.
- Logging to the index begins when the index is enabled.
Query the Search Audit Index
- In the Search page, enter the query
- Choose the time range for the audit events you’d like to review.
- Click Start to run the search. Results return in the Messages tab.
Querying the index returns results only if the index is enabled.
Index retention period
By default, the retention period of the Search Audit index is the same as the retention period of your Default partition. You can change the retention period by editing the partition that contains the index,
sumologic_search_usage_per_query. For more information, see Edit a Partition.
Log Search Audit Index message fields
The following table provides details on the fields returned by the index:
|The time when the audit log was generated.|
|The data tier associated with the audit message. Learn more about Data Tiers.|
|Amount of data retrieved by the search query. This represents the approximate size of messages that match the source expression of the query and are retrieved from scanning.|
|Amount of data scanned by the search query. This value is an approximation, as the scanned message bytes are captured at intermittent time intervals and then averaged over the query time range. It is important to note that this value may be less than the retrieved bytes in some cases due to the approximation. Additionally, if a query contains a |
|Time taken to complete the search.|
|The boolean variable that indicates if the corresponding search query was an aggregate query. The aggregate operator’s list can be found in Group or Aggregate Operators.|
|The query text string run by the user.|
|The end time in the time range specified as part of the query time parameter, in milliseconds since epoch.|
|The start time in the time range specified as part of the query time parameter, in milliseconds since epoch.|
|Identifies the type of query run within the account such as API, UI, Scheduled Views, etc. The values and their detailed description are provided in Query type field values.|
|The remote IP of the source from where the query originated.|
|The number of messages returned by the search result. This represents the approximate count of messages that match the source expression of the query and are retrieved from scanning.|
|The number of messages scanned by the search. This is an approximation, as |
|The number of partitions scanned by the search. This is an approximation as scanned message bytes are captured at intermittent time intervals and averaged over a query time range. (May be less than retrieved bytes in some cases due to this approximation.)|
|An identifier for every search run within the account. This is the same SESSION number displayed in the UI in the search tab.|
|Gives the status of the search. The values include: Finished successfully, Query failed, and Query canceled.|
|The email of the user that ran the search.|
Query type field values
The table below shows the possible values for the
|Search API||Search queries run by users using the Search Job API only.|
|Interactive Search||Search queries run from the Search tab in the UI only.|
|Interactive Dashboard||Search queries run from dashboards in the UI only.|
|Scheduled Search||Scheduled search queries run as per the frequency specified by users in the org.|
|View Maintenance||Scheduled View queries run on behalf of the users in the org.|
|Sumo Internal||The Internal searches Sumo Logic runs in the background that are critical in providing other services (for example, autocomplete, scheduled view optimization, etc.).|
|Live Dashboard||Search queries used to power live dashboard panels.|
|Monitor||Queries associated with monitors.|
|Span Analytics||Queries run for filtering and aggregating trace data based on span attributes to understand application services performance. Queries can be built using input fields, with filters and visualized results available.|