Construct a Search Filter for a Role
This page describes how to define search filters for a role. These instructions apply to the Search Filter option in Step 6 of the Create a role procedure.
Understanding search filters
A search filter for a role defines what log data a user with that role can access. You can define a search filter using keywords, wildcards, metadata fields, and logical operators. Here is a simple role filter:
_sourceCategory=labs*
This filter grants access to logs whose _sourceCategory begins with the string “labs”. (Logs whose _sourceCategory don’t start with “labs” won’t be accessible.)
When a user with this filter enters a query like:
_sourceCategory=labs/apache | parse "* --" as src_ip | count by src_ip | sort _count
Sumo silently (it’s transparent to the user) adds the role filter to the beginning of the query with an AND:
_sourceCategory=labs* AND (_sourceCategory=labs/apache | parse "* --" as src_ip | count by src_ip | sort _count)
The example above positively grants access to log data. You can do the opposite: explicitly deny access to data, with an exclamation point (!). For example:
!_sourceCategory=JobX*
The role filter above denies access to log data whose _sourceCategory begins with “JobX”. (Access to log data with other source category values is not restricted.)
The examples above are simple: they involve a single role, and hence a single role filter.
Typically however, a Sumo user will have multiple roles. If a user has multiple roles, Sumo ORs the several role filters and prepends that expression to the user’s queries with an AND, as discussed in Multiple role filters and filter precedence.
Search filter basics
The sections below list search filter limitations, and describe how you can use keywords, wildcards, metadata, and logical operators in filters.
The explanations of the behavior of each example filter assume that no other role filters apply. In practice, you will likely assign multiple roles to users. After you understand the basics of how role filters work, see Multiple role filters and filter precedence.
Search filter limitations
- Role filters should include only keyword expressions or built-in metadata field expressions using these fields:
_sourcecategory,_collector,_source,_sourcename,_sourcehost. - Using
_indexor_viewin a role filter scope is not supported. - Role filters cannot include vertical pipes (
|). - Role filters apply to log searches, not metric searches.
- The _dataTier search modifier is not supported in role filters.
- If one or more of your Field Extraction Rules (FERs) override the out-of-the-box metadata tags you use in your search filters for a role, Live Tail can still provide access to data outside of the scope intended in your search filter. You should either avoid overriding out-of-the-box metadata tags in your FERs or avoid overridden tags in your search filters.
- Using a field or FERs in a role filter is not supported. It will cause errors for any search run by a user in the role where the field is not valid. For example, if an FER created a field
foo, adding thefoo=barscope to a role will break any search for a user where this field is not valid. This most often causes errors where users search a view where the field is not a valid schema field in that view.
For limitations related to the use of Scheduled Views or Partitions in a search filter, refer to Partitions and Scheduled Views.
Using metadata in a search filter
You can use metadata fields in a role search filter. The following search filter grants access to log data from a Collector named “HR_Tools”, and no other data:
_collector=HR_Tools
When a user with that role filter runs a query, Sumo prepends the filter to the query with an AND:
_collector=HR_Tools AND <user-query>
Using AND and OR in a search filter
You can use AND and OR in a search filter. For example, this role filter uses OR to grant access to log data from two source categories:
_sourceCategory=stock OR _sourceCategory=insurance
When a user with that role filter runs a query, Sumo prepends the filter to the query with an AND:
(_sourceCategory=stock OR _sourceCategory=insurance) AND <user-query>
This role filter below uses AND to grant access to log data with the source category “insurance” from the collector named “HR_Tools”:
_collector=HR_Tools AND _sourceCategory=insurance
When a user with that role filter runs a query, Sumo prepends the filter to the query with an AND:
(_collector=HR_Tools AND _sourceCategory=insurance) AND <user-query>
Using keywords in a search filter
You can include a string you want to search for in a role search filter. This role filter grants access to logs from the collector named “HR_Tools” that contain the string “enrollment”:
_collector=HR_Tools AND enrollment
When a user with that role filter runs a query, Sumo runs it like this:
(_collector=HR_Tools AND enrollment) AND <user-query>
Using wildcards in a search filter
You can use an asterisk (*) as a wildcard in a role search filter. This role filter grants access to logs from all collectors whose name begins with “HR”:
_collector=HR*
When a user with that role filter runs a query, Sumo runs it like this:
_collector=HR* AND <user-query>
This role filter grants access to logs that contain the string “violation” from all collectors whose name begins with “HR”.
_collector=HR* AND violation
When a user with that role filter runs a query, Sumo runs it like this:
(_collector=HR* AND violation) AND <user-query>
Using ! as a NOT in a search filter
You can use an exclamation point character (!) in a role search filter to restrict, rather than allow, access. For example, this filter:
!_sourceHost=humanresources* AND !_sourceName=*finance* AND !_sourceCategory=*secret*
denies access to log data whose:
_sourceHostbegins with “humanresources”_sourceNamecontains “finance”_sourceCategorycontains “secret”
When a user with that role filter runs a query, Sumo runs it like this:
(!_sourceHost=humanresources* AND !_sourceName=*finance* AND !_sourceCategory=*secret*) AND <your-query>
Multiple role filters and filter precedence
When a user is assigned to multiple Sumo roles, Sumo combines the role filters from each of the roles using a logical OR to come up with the combined role filter.
When multiple roles filters are applied to a query, the least restrictive filter takes precedence. That this rule doesn’t apply if any of the role filters applied to a query is simply blank, which effectively grants access to all data, and would be the least restrictive filter. If the combined search filters applied to a query includes filters that are blank, the blank search filter is ignored and the next least restrictive filter takes precedence. So, if you actually want to grant a role access to all data, set the search filter to an asterisk (*). A search filter that is configured in that fashion will take precedence when combined with more restrictive search filters.
Example 1
Assume the following role filters.
| Role | Filter |
|---|---|
| Role A | _source="GCP Audit" AND _collector="GCP" |
| Role B | _sourceCategory="Vx*" |
Role A allows access to log data whose _source tag is “GCP Audit” and _collector tag is “GCP”.
Role B Allows access to log data whose _sourceCategory tag begins with “Vx”.
When a user with Roles A and B runs a query, Sumo applies the filters with an OR, and prepends them with an AND to your query, like this:
((_source="GCP Audit" AND _collector="GCP") OR _sourceCategory="Vx*")
AND <your-query>
The combined filters enable access to log data whose _source tag is “GCP Audit” and _collector tag is “GCP”, and to any log data whose _sourceCategory tag begins with “Vx”.
Example 2
Assume the following role filters.
| Role | Filter |
|---|---|
| Role A | _collector=fee* |
| Role B | !_collector=fi* |
Role A allows access only to log data whose _collector tag matches “fee*”, and not to data whose _collector tag is any other value.
Role B Allows access to any log data whose _collector tag does not match “fi”.
When a user with Roles A and B runs a query, Sumo combines the two filters with an OR, and prepends them with an AND to your query, like this:
(_collector=fee OR !_collector=fi) AND <your-query>
The least restrictive of the role filters takes precedence. So, although Role A effectively restricts results to log data that matches _collector=fee*, Role B allows grants access to all collectors, except for those that match _collector=fi*. So, Role B takes precedence and Role A has no effect.
Example 3
Assume the following role filters.
| Role | Filter |
|---|---|
| Role A | _sourceCategory=analytics-lab* |
| Role B | _sourceCategory=analytics* |
Role A allows access only to log data whose _sourceCategory is “analytics-lab”.
Role B Allows access to log data whose _sourceCategory begins with “analytics”.
When a user with Roles A and B runs a query, Sumo combines the two filters with an OR, like this:
(_sourceCategory=analytics-lab OR _sourceCategory=analytics*) AND <your-query>
The least restrictive of the role filters takes precedence. Role A alone grants access to a log data from a single source category, “analytics-lab”. Role B grants access to log data to any source category that starts with “analytics”. Since the least restrictive filter takes precedence, data tagged _sourceCategory=analyticsLong could be returned in addition to data tagged _sourceCategory=analytics-lab.
Example 4
Assume the following role filters.
| Role | Filter |
|---|---|
| Role A | _collector=prod* |
| Role B | !_sourceCategory=*shoguns* |
Role A allows access to log data whose _collector tag matches “prod*”, and not to data whose _collector tag does not.
Role B prevents access to log data whose _sourceCategory tag does contain “shoguns”. Data with any _sourceCategory tag that does not contain “shoguns” is available.
When a user with Roles A and B runs a query, Sumo combines the two filters with an OR, and prepends them with an AND to your query, like this:
(_collector=prod* OR !_sourceCategory=*shoguns*) AND <your-query>
Role B is the least restrictive. Users with the combined role filter will be able to view any log data whose _sourceCategory does not contain the string “shoguns”, regardless of the value of the _collector tag.
Example 5
Assume the following role filters.
| Role | Filter |
|---|---|
| Role A | _index=sumologic* |
| Role B | Blank search filter |
Role A allows access to all indexes whose name starts with "sumologic".
Role B, with a blank search filter (user did not enter anything as the search filter for the role), allows access to all data.
When a user with Roles A and B runs a query, Sumo combines the two filters and since Role B has a blank search filter, the more restrictive search filter, Role A, takes precedence. Users with the combined role filter will be able to view any log data in any of the indexes prefixed with "sumologic".