Using the Logs toolbar

Using the Logs toolbar

576a2e8d-1dc6-4166-88ce-fe1eebec9f82.png

You can modify the following options in the Logs toolbar:

logs-toolbar.png
Logs toolbar

Setting

Description

Setting

Description

Refresh data

Click Refresh data to update the Logs page with the latest logs.

Display options

Click Display options to open the Display options panel and select which columns to display in the Logs page. Check the checkbox(es) of the column(s) to display, and click Apply. The following are the list of display options:

Click Display options to select which columns to show in the Logs page. Check the checkboxes for the columns you want to display, then click Apply. The available display options are:

  • Show all columns

  • Timestamp

  • Severity

  • Origin

  • Execution ID

  • Message

Filter

Click Filter to open the filter panel and display events based on specific criteria in the Logs page.

In the Filter panel, you can filter the logs using all, or a combination, of the following criteria:

Log Filter view.png
Filter panel

Criteria

Description

Criteria

Description

Search

Filters the logs by the message text.

In this section you can filter the logs by the Message text, Stream version, or by Execution ID if you have switched on Advanced mode, see more information below:

Log Filter.png
Filter logs default view
Log filter message search.png
Filter logs Advanced mode

The search section uses OpenSearch regular expressions and operators to match results in the logs. For more information on regular expressions and syntax, see https://docs.opensearch.org/docs/latest/query-dsl/regex-syntax/.

Examples of how the search bar matches results:

  • Searching with the single-word expression fish filters the log to display any results that contain the word “fish”, including “Fish & Chips” and “I love fish chips.

  • Searching with the boolean OR expression fish OR chips filters the log to display any results that contain the word "fish" or "chips" in any order, including "fish", "Chips", "I love fish chips", "Fish & Chips", and "I love bamboo & Fish." The expression is not case-sensitive.

  • Searching with the boolean AND expression fish AND chipsfilters the log to display any results that contains both "fish" and "chips" in any order, including "I love fish chips", "Fish & Chips", and "I love chips and Fish I love almost as much." The expression is not case-sensitive.

  • Searching with the quoted string expression "collectors have finished" filters the log to display results that only match the entire quoted phrase, such as "All collectors have finished.

  • Searching with the regular expression .*[fd]ish.*[0-9]+filters the log to display any results that only contain the words "fish" or "dish" in lower case, in that order, and ends with a numeric value, such as "I love fish dish number 4.” When using regular expressions, filtering is case sensitive.

When Advanced is toggled on, you can also filter by Execution ID.

Date

You can filter the logs from a dropdown of pre-defined time and day.

Log Filter Date.png
Selecting the date period

When Custom is selected, you can filter logs by specifying the From and To date and time in the YYYY-MM-DD HH:mm:ss format.

Log Filter Date Custom.png
Custom date selection

Severity

You can filter logs by Severity type:

  • Information

  • Warning

  • Error

Select the checkbox for the Severity type you want to display in the Logs page.

Logs Filter Severity.png
Severity checkbox options

Origin

You can filter logs by the origin of the event, which indicates which function generated the event. Select the checkbox for the function type:

  • Collectors

  • Processors

  • Forwarders

Log Filter Origin.png
Origin default view

When Advanced is toggled on, you can also select specific functions in the stream to display in the Logs page.

Log Filter Origin Advanced.png
Origin Advanced mode

Once you have set the combination of filter criteria, click Filter. The Logs page then filters the logs by the filter criteria.

You may adjust the filter criteria accordingly and click Filter again to re-filter to the new set of criteria in the Logs page.

When a filter is applied to the Logs page, it is indicated with ‘Filter applied’ on the Filter option.

After you set the filter criteria, click Filter. The Logs page displays logs that match your criteria. You can adjust the filter criteria and click Filter again to update the results. When a filter is applied, the Filter option shows Filter applied.

Log Filter applied.png
Logs page showing the ‘Filter applied’ flag

To reset the filter settings, click Clear filter in the Filter option or at the bottom of the Filter panel.