Log Tap

Use a Log Tap node in your Flow to send log messages to the Flow Editor Debug sidebar, and to Agent Logs, with varying levels of detail based on your development needs and operational preferences. The TTL for all log messages in your Contextual tenant, is 24 hours.

Basic Node Usage Example

By adding a Log Tap node in between key operations in your Flow, log messages will be written containing important information about the status of operation of the Flow, at that point, based on the configuration of the Log Tap node itself.

Configuring a Log Tap Node

To configure a Log Tap node in the Flow Editor, drag it from the Palette to the Workspace canvas, then double-click the node to open and configure its behavior.

Example of settings for a Log Tap node

1. Provide an optional Name for the node.

   • By default a Log Tap node will be shown with a label of "log tap", but the value you provide in the Name field will replace it in the Flow Editor UI making your flow easier to read and understand.

   • This value will also be included in the Flow Editor Debug Panel, as well as in Agent Logging, to help find and understand log messages.
2. Choose the desired detail of logging for Output.

   • msg. - note

   • complete message object - note

   • expression - note

3. Choose the desired level for the log message, using Log Level. Log Tap nodes will generate messages based on the Agent Log Level setting of any Agent that sends events to your flow, a setting which can be changed at any time without restarting the agent.

   • debug - typically used for logging messages with a high level level of detail, useful during software development and debugging. Debug logs are typically not enabled in a production environment unless troubleshooting a specific issue due to the high volume of log output that can be generated.

   • info - typically used for informational messages that highlight the progress of an application at a coarse-grain level. Info logs are typically enabled in a production environment to provide a general sense of application activity without being too verbose.

   • warn - typically used to indicate there is a potential issue or a situation that could lead to a problem in the future, but the application is running as expected. Warn logs are typically always enabled.

   • error - typically used to log error events that might still allow the application to continue running. Error logging usually captures events that are not fatal but significant. Error logs are always enabled.

4. Select Send to Console to collect the log message as part of Agent Logs. If this option is not selected, log messages will not be available in Agent Logs.
5. Select Send to Sidebar to display the log message in the Flow Editor Debug sidebar, which is specifically useful for in-flow testing with the debugger, allowing you to quickly test and observe many aspects of your flow development, without requiring an Agent restart for quick testing and validation.