Searching for CSE Records in Sumo Logic
This topic has information about how to search the Sumo Logic platform for Records and Signals that have been forwarded from CSE. For more information about performing log searches in Sumo Logic, see Search Basics.
Partitions with CSE data
This section has information about the Sumo Logic partitions that contain CSE data.
Partitions for CSE Records
In CSE, normalized Records are categorized by Record type, for example, Audit, Authentication, Network, NetworkDHCP, and so on.
In Sumo Logic, Records are stored in partitions, which are indexes that enable better search performance. The table below shows which partition each Record type is stored in. Note that some partitions contain multiple Record types.
|CSE Record type||Sumo Logic partition|
There is a separate partition for forwarded raw messages for which Records were not created, because no log mapper was available.
Partitions for unmapped messages
|CSE Record Type||Sumo Logic partition|
Partition for CSE Signals
CSE Signals are retained in the sec_signal partition. Signals are saved in JSON format, and support search by keyword and nested attributes.
The sec_signal partition is automatically generated, and its contents are retained for two years, at no additional cost.
About the Security Record Details view
When you query CSE Records or Signalsin a Sumo Logic log search tab, the contents of each Record or Signal are presented in a field named Security Record Details. The Security Record Details is somewhat unique in that it can't be referenced in a query itself. It is a read-only field. Note however, that you can add subfields of the Security Record Details field as separate columns in the field browser. You can see an example of doing that in Save a query with predefined display fields below. And like any other field, you can hide the Security Record Details field, if desired.
Search Records or from the Partitions page
If you have the View Partitions role capability, you can search CSE partitions from the Partitions page in the Sumo Logic UI.
- Go to Manage Data > Logs > Partitions.
- The partitions that contain CSE Records begin with the string "sec_record".
- To search for all content in the partition, click the icon that appears next to a Partition name when you hover over a row.
- A log search tab opens with a query, like
_index=PartitionName, that returns all of the logs created within the currently selected time range, 15 minutes by default. For a description of the results, see Search all Records in a partition, below.
Search data in a log search tab
To search a Sumo Logic partition, you specify the name of the partition using
_index= PartitionName. The sections below provide instructions for scoping a search so that it returns the data you’re interested in.
Open a log search tab
To open a log search tab in Sumo Logic, click + New and select Log Search.
Search all Records or Signals in a partition
To return all the Records or Signals in a partition, all you need to include in your query is the partition name. For example, to search all Records in the
sec_record_network partition, choose a time range, enter this query, and click Start:
- The query returns all of the Record types that are stored in the partition: Network, NetworkDHCP, NetworkDNS, NetworkFlow, NetworkHTTP, and NetworkProxy
- By default, two Record fields are displayed:
Security Record Details, which contains all of the data from the underlying Record. You can display additional fields by checkmarking desired fields in the Hidden Fields area. You can also use the fields operator to specify the fields you want displayed and save the search as described in the following section.
Save a query with predefined display fields
You can use the
fields operator to choose the fields you want to be displayed when you run the search. You can add additional fields to those that are displayed by default.
To add display fields:
This query adds the
objectType (which contains the Record type) and the
user_username fields to the displayed output:
_index = sec_record_audit
| fields objectType, user_username
To save a search
- To save the query for future use, choose Save As from the three-dot more options menu in the search bar.
- On the Save Item popup, name the query, choose a folder location, and then click Save.
Search multiple partitions
You can search multiple partitions by using
OR in the query. For example, to search all Records in the
_index = sec_record_audit OR _index = sec_record_network
Search all Record partitions
To search all Records in all of the in partitions that contain CSE Records, use an asterisk (
_index = sec_record_*
Query by Record type
objectType field in a Record indicates its Record type. To restrict results to a particular Record type, use
_index to identify the partition that contains that Record type, and
objectType to specify the Record type. For example, to search for NetworkHTTP Records in the
_index = sec_record_network objectType=NetworkHTTP
Return a count of Records by Record type
You can use the count operator to aggregate your query results. In the following query, we use the asterisk wildcard to search across all partitions that contain CSE Records, and count the results by
objectType, which contains the Record type. The following query returns the count of Records of each type.
_index = sec_record_*
| count as Total _view, objectType
| order by Total
Search by keyword
You can search CSE fields by keyword, for example:
Referencing nested JSON fields
The Security Record Details field contains a JSON object with all of the fields from the underlying Record or Signal. Some of the data is nested in one or more sub-objects, like the
fields object for Record., shown expanded in the screenshot below. The fields object contains the contents of the fields field in the underlying Record, which is all of the unnormalized data from the original log message before it was normalized to the CSE schema.
You can access the contents of nested attributes, like
fields in the example below, using a
| where %"fields.application" = "test_app"
Security index search limitations
- When you use wildcards for field values in a query scope, only Records in which those fields are present and not null will be returned. For example, the following query will only return Records if the
srcDevice_ipis present and not null:
_index = sec_record_* srcDevice_ip=*
- The partitions that contain CSE Records and Signals are stored in a dedicated security data tier. You can’t access data in the security indexes and data in other data tiers (Continuous, Frequent, or Infrequent) in the same query.