Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Logs allow you to see detailed information about how a stream execution went, search for errors, and form an understanding of the timeline of events. The Logs viewpage provides you with the details of the events generated every time you run a stream.

Note!

There can be some cases where no logs will be displayed, for example, HTTP Functions where only errors will be shown.  

...

Opening the Logs

...

page

You can access open the Logs viewpage by clicking View logs from in the Stream Editoreditor.

...

Alternatively, when in the Streams view tab, under the Actions column of a stream, click the More drop-down, then click Log.

...

The Logs

...

page

You see the following information in the Logs viewpage:

Column

Description

Timestamp

The date and time the event was generated. The timestamp is displayed in the YYYY-MM-DD HH:mm:ss:fff format.

Note!

The timestamp is displayed according to the browser’s local timezone.

Severity

Indicates the event type:

  • Information

  • Warning

  • Error

Origin

The origin of the event, namely which function generated the event. This column displays ‘Engine’, ‘Data correction’, ‘Stream audit’, and ‘Tx manager’ for logs that do not come from a particular function.

Execution ID

The Execution ID of the event.

Message

The message generated for the event.

Note!

If the message is larger than 4000 characters, it is truncated. 

Click on a log entry to expand it and view more information about the event, such as the Execution ID and the complete message of the event. Click the clipboard icon to copy details such as the Execution ID.

You can select how many rows you can view on a page. The default setting is 100 rows per page. The current logs display limit is 10,000 log entries.

...

Logs

...

page toolbar

You can control the Logs viewpage with the options in the Logs view barpage toolbar:

  • Filter

  • Display options

  • Refresh data

...

Click Refresh data to refresh the Logs viewpage with updated logs.

Display options

Click Display options to open the Display options view and select which columns to display in the Logs viewpage. Check the checkbox(es) of the column(s) to display, and click Apply.

...

Click the Filter option to open the Filter viewpanel to display events based on certain criteria in the Logs viewpage.

...

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

Criteria

Description

Search

Filters the logs by the message text.

Text message.pngImage Removed
Log filter message search.pngImage Added

The search bar uses the Elasticsearch regular expression and operators to match with results in the logs. See this Elasticsearch guide for more information on regular expression and syntax.

Some examples of how the search bar matches results:

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

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

  • Searching with the boolean AND expression fish AND chipsfilters the log to display any results that have the word "fish" and "chips" in any order, including "I love fish chips", "Fish & Chips", and "I love chips and Fish I love almost as much." Note that 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 have 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.” Note that when using regular expressions, filtering is case sensitive.

When Advanced is toggled on, you may also filter by:

  • Execution ID

  • Replica ID

Note

Note!

Replica ID is available only for certain accounts.

Text message advanced.pngImage Removed
Log Filter Message Advanced.pngImage Added

Date

Filters the logs from a drop-down of pre-defined time and day.

Date search.pngImage Removed
Log Filter Date.pngImage Added

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

Date custom.pngImage Removed
Log Filter Date Custom.pngImage Added

Severity

Filters the logs by the Severity type.

  • Information

  • Warning

  • Error

Check the check box of the Severity type to display in the Logs view.

Severity.pngImage Removed
Logs Filter Severity.pngImage Added

Origin

The origin of the event, namely which function generated the event. Check the check box of the function type to display in the Logs view.

  • Collectors

  • Processors

  • Forwarders

Origin.pngImage Removed
Log Filter Origin.pngImage Added

When Advanced is toggled on, you may check the check box of the specific function in the stream to display in the Logs view.

Origin filter.pngImage Removed
Log Filter Origin Advanced.pngImage Added

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

...

If you want to reset the Filter view, click Clear filter at the Filter option or at the bottom of the Filter panel.

Page Properties
hiddentrue

Will be implemented in Sprint 191

Advanced Search Options 

It is possible to conduct advanced queries by using special parameters. To conduct the queries, follow the `<fieldToMatch>:<matchQuery>` format. Possible options are the following: 

  • '-' –This denotes the NOT logical operation.

  • '+' – This denotes the AND logical operation.

  • '|' – This denotes the OR logical operation.

Any queries that are placed in `"` will match the full phrase. Placing `(` and `)` will indicate precedence over other queries. 

...