4.1 Creating Filters

Filter criteria are simple math expressions and simple evaluations. Filters work on selection sets by matching events against the specified criteria. If the match is TRUE, the event is displayed in real-time views or search results, or passed to other functions. If the match is FALSE, the event is blocked. The filter criteria is nothing but your search query.

For example, consider a search query that is written as follows:

(sip:"10.0.0.1")

Events whose source IP address is 10.0.0.1 are included in the filter.

You must use the event field ID to represent an event name. Click the Tips link on the top right of the Sentinel Main interface for a list of event field names and their IDs.

For information about the syntax for the criteria, see Section A.0, Search Query Syntax.

4.1.1 Building a New Criteria

The Build criteria interface provides a list of parameters required to build filter criteria ranging from simple to complex. You can either select the parameters, or you can manually specify the filter criteria.

For information about the syntax for criteria, see Section A.0, Search Query Syntax.

The Build Criteria dialog box includes the following elements:

Table 4-1 Build Criteria Dialog Box Elements

Element

Description

Criteria

If you select Structured, this field displays the criteria formed by the parameters you select. You cannot modify or specify the filter criteria.

If you select Free-form, you can manually specify the filter criteria.

Structured

Allows you to select the various parameters to build the filter criteria.

Free-form

Allows you to manually specify the filter criteria rather than selecting from the available parameters.

The search criteria is based on the standard Lucene syntax with some Sentinel extensions. For information on creating a filter criteria (search query), see Section A.0, Search Query Syntax.

If this option is selected, the following elements are not displayed:

  • Event fields

  • Criteria fields

  • Field details

Exclude system events

Select this option to exclude Sentinel internal events such as audit events and performance events from the search results.

Event fields

Displays a categorized list of possible event fields you can add to the filter criteria. You can expand each category to display the set of fields in that category. If you know the name of the field you want, specify the name in the Search field. The event category list will adjust to present only matching fields.

For more information on event fields, click Tips located at the top right of the Sentinel Main interface.

Criteria fields

Lists a set of overlay criteria that you can use on top of per-field searches. The following fields are displayed by default:

  • All data: Performs a search across all event fields.

    For more information, see The Default Search Field in Section A.0, Search Query Syntax.

  • Tags: Events can be tagged in various ways to help identify relationships between events. Queries that include a “Tags” search will look at the event tags (rv145) for matches.

  • Taxonomy: Events are also classified using a number of taxonomic categories for the action, outcome, and so on. Queries that include a “Taxonomy” search will search for specific classes of events.

    For more information on taxonomy, see Sentinel Taxonomy.

Field details

The fields in this section vary depending on the event or criteria fields you select. For example:

  • For tokenized fields, you can specify the words that you want to include or exclude in the filter criteria. For information on the tokenized and non-tokenized fields, click Tips located at the top right of the Sentinel Main interface.

  • For non-tokenized fields, you can specify a value or a range of values.

  • For taxonomy fields, specific taxonomy options are displayed.

  • For date attributes, a date-time calendar is displayed as you type the date. You can select a date.

  • For fields that contain internal Sentinel UUIDs, such as the CollectorID field, the corresponding Sentinel object names are displayed and can be selected.

Condition: AND OR

Allows you to specify the AND or OR condition between the criteria fields. These options are available when you add additional event criteria to the criteria fields.

4.1.2 Selecting an Existing Criteria

You can create a filter by using existing criteria from the predefined criteria list. The filter can be based on recent criteria, tags, or existing filters.

  • Show only recent criteria: Select a search criterion from the recent search history. The search history displays a maximum of 15 search expressions. Select the criteria, click Show only recent criteria, and then click Add.

  • Show only tags: You can search events that have a particular tag. Click Show only tags to list the tags in the system. Select the tags, and then click Add.

  • Show only filters: You can reuse existing filters to perform a new search. Click Show only filters to list the existing filters. Select the filter on which you want to perform the search, and then click Add.

You can combine multiple criteria, tags, or filters by using the And or Or condition. After adding the criteria, you can test the filter by clicking Test Filter.

4.1.3 Creating a Filter

You can create filters either by building a new filter criteria or by saving a search query as a filter.

While creating a filter, you can specify whether you want to share a filter with other users. You must have the Share Search Filters permission to share filters with everyone or with users in the same role as yours. If you are a user in the administrator role, you can share filters with users in a different role.

In Sentinel Scalable Data Manager, you can create a filter only by saving the search query as a filter. For more information, see Saving a Search Query as a Filter.

Creating a Filter by Using the Build Criteria Dialog

  1. From Sentinel Main, in the navigation panel, click Filters > Create a filter.

  2. Select one of the following methods to create a filter criteria:

    • To build the filter criteria by selecting parameters, make sure that Structured is selected, select the parameters, then continue with Step 3.

      For information on these parameters, see Table 4-1, Build Criteria Dialog Box Elements.

    • To manually specify the filter criteria rather than selecting the listed parameters, select Free-form. In the Criteria field, specify the filter criteria, then continue with Step 3.

      For information about the syntax for the criteria, see Section A.0, Search Query Syntax.

  3. (Conditional) If you do not want to include Sentinel internal events in the search, select Exclude system events.

  4. Click Search to search events according to the specified filter criteria.

    By default, the search is performed on events that were generated within the last 1 hour.

  5. Review the search results to verify that the filter is retrieving the expected events.

  6. (Optional) You can modify the search query by selecting one or more event field values from the search results, or you can click Edit search filter, then make necessary changes.

  7. When you are satisfied with the search results, click , then click Save as Filter.

  8. Specify a name for the filter and an optional description.

  9. In the Sharing drop-down list, select one of the following options to specify the access for this filter:

    • Private: Allows you to make this filter private. Other users cannot view or access this filter.

    • Public: Allows you to share this filter with all users.

    • Users in same role: Allows you to share this filter with users who have the same role as yours.

    • Users in selected roles: Allows you to share this filter with users in specific roles. If you select this option, a blank field is displayed where you can specify the roles. As you type the role name, a list of roles is displayed.

      Select one or more roles.

      NOTE:This option is available only for users in the administrator role or users with the Share search filters permission.

  10. Click Save.

Creating a Filter by Using a Search Query

You can save a search query as a filter and use this filter to perform searches when required rather than specifying the search query again. For more information about creating a filter by using a search query, see Saving a Search Query as a Filter.