Skip to main content

Facet

Overview​

The facet sidebar (the Filters panel in the v2 interface) is located on the left side of Datalake Search and of the search pages Cases Search, Notable Events, and Configuration → Behavior Rules (v1: the Events Search page, Data Lake → Search, and the SIEM search pages Behavior Summary, Behavior Timeline, and Behavior Rules).

The facet acts as a filter allowing information to be focused on or removed from results on the page. Information in the facet is presented first by the field attribute. Results for the field attribute are presented underneath in order of the number of times that value appears in the result set, the count.

In this section these three components are referenced:

  • attribute: how data is grouped: e.g. "Tags"
  • value: the values in the attribute field: e.g. "WARNING", "INFO", "sshd", "hb", "systemd"
  • count: the number of times that value appears in the set: e.g. "79776", "32494", "21715", "5784", "5223"

Three State Selection​

Each value in a field group is listed with a checkbox and its count. A value starts out not filtered, and clicking it moves it through the filter states:

  • Included: the checkbox is ticked, and a chip for the value, such as Event Types: ServicePrincipalSignInLogs, appears above the histogram. Results must include one of the included values in the group.
  • Excluded: the checkbox turns red, the value is struck through, and the chip turns red with NOT in front. Results must not include the value, regardless of any other included values.
  • Cleared: a third click removes the filter, and the value is back to not filtered.

Event Types group with ServicePrincipalSignInLogs struck through in red, and a red NOT Event Types: ServicePrincipalSignInLogs chip above the histogram

Each value's accessible label, read out by screen readers, states its current state and what the next click does: ServicePrincipalSignInLogs: not filtered. Click to include., then …: included. Click to exclude., then …: excluded. Click to clear filter.

Field Groups​

Each group is headed by its name and, in brackets, the number of distinct values found: Event Types (3). A group with nothing to count reads No values in this window. The × at the right of a group heading removes that group from the panel.

+ Add field at the bottom of the panel adds a group of your own. On Datalake Search it opens a small form: Display name, the group's heading, and Field value, the event field to count (@field.path), with an Add field button that is available once both are filled; on Cases Search and Notable Events it opens a Filter fields… list of the fields found in the results.

Relationship Between Attributes​

Checked boxes between attribute types act like logical and statements, while checked boxes in the same attribute act as logical or statements.

Excluded values are removed from all results regardless of checked boxes elsewhere.

Running and Resetting the Facet​

Set the values you want, then press Search in the search bar to run the search with them.

The chips above the histogram list every filter that is set. The × on a chip removes that filter; Clear all beside the chips removes them all.

The « button in the panel's header (Collapse filters) folds the panel into a narrow strip labelled FILTERS, with a badge counting the active filters, giving the results the full width; » opens it again.

Facet Configurations​

For each page there is a default facet configuration. On the events search page, users can also create their own facet configurations and save them for later use.

Saving a Configuration​

On Datalake Search, Save Facet in the toolbar saves a search facet from the page. It opens the Save Search Preset dialog: give the facet a Name that no other facet has, and optionally a Description, then click Save Facet. The Filters panel's field groups, including any added with + Add field, are saved as a facet for the selected index, and the panel switches to it. Datalake Search describes the dialog.

Saved facets (each a set of fields, with a query and indexes) are offered by the Filters panel's facet selector and managed on Configuration → Search Facets.

Switching Configurations​

The FACET drop-down at the top of the Filters panel on Datalake Search chooses the configuration the panel shows. Default shows Behaviors, Event Types, Sources, Senders, Parsers, and Tags; the other facets are named after the data they suit, such as Default-AWS_CloudWatch, Default-Fortigate, Default-Microsoft_Defender_Events, or GSuite, and bring their own groups. Datalake Search describes the selector.

Facet drop-down open in the Filters panel, listing Default followed by facets such as Default-AWS_CloudWatch, Default-BoxCom_Events, Default-Cisco_ASA and Default-Fortigate

The drop-down offers the facets that fit the selected index: an index with facets of its own, such as managed-MSEntra, lists Default and those. Choosing a facet asks before it changes the search: a facet with a query of its own offers to replace the current query and filter selections with that query, and one without offers to clear them. Confirm to apply the change, or cancel to keep the current query; the panel shows the chosen facet's groups either way.

The Facet Library​

The library of saved facet definitions is its own page, Configuration → Search Facets: a table of profiles with GROUP, NAME, DESCRIPTION, INDEXES, and ACTIONS columns, each row offering Edit, Download, and Delete, and Import and Create Facet buttons in the header.

Search Facets page with Import and Create Facet buttons, a search field, and a table of facet profiles with group, name, description, indexes, and Edit, Download, and Delete actions

Create Facet and Edit open the same form: Name, Description, and Indexes under Details; an optional Query (such as @parser:aws); and under Fields one numbered row per facet, each with a drag handle for reordering, a Title (the group's heading on Datalake Search), a Field (the event field it counts), and Delete. Import loads profiles from a JSON file in the format Download produces; see Import and Download and Delete.

Exporting Results​

To export the loaded results, use Export JSON at the right end of the toolbar on Datalake Search (not the Filters panel). It downloads them as newline-delimited JSON (an .ndjson file, one event per line), and is disabled until a search returns records.