Debug issues using logs

This guide outlines the importance of reading logs for debugging issues on our platform, distinguishing between Execution Logs and Audit Logs.

To effectively debug issues, you need to read and interpret logs for several purposes:

Identify the exact state of the controller: Determine the current status and behavior of the system controller.
Determine the triggered flow: Identify which flow is being activated during the interaction.
Follow execution steps: Track the step-by-step execution of each function to understand the flow of operations.
Inspect stored values: Check what values are stored in variables throughout the process.
Identify error: Find errors causing disruptions in the flow.
Review API: Examine the response and status code of API requests to ensure they are functioning correctly.

Types of logs on our platform

Our platform provides two types of logs to assist in debugging:

Execution logs: These logs help identify API failures that disrupt flows. They offer a detailed, step-by-step account of each flow's execution, making it easier to pinpoint issues.
Audit logs: These logs store all operations performed on the platform, such as database deletions, journey deletions, and audience table deletions for audit purposes.

Using execution logs to identify errors:

Use the UID to identify errors: To troubleshoot issues more precisely, use the UID (Unique Identifier) to trace errors. You can fetch the UID of any conversation transcript from the network tab API. To do this on the Live bot page, right click > Inspect > Network > Payload.
Additional methods for viewing logs (for Production bots only): For production bots, there are advanced methods available to access and review logs, which provide deeper insights into the bot's operations and help identify critical issues.

To read the logs, follow these steps:

Go to Automation > Analysis > Conversation logs.
Go to the conversation log.
Click on Logs.
Click Debugger icon to get the logs for any user input and see what happened in the bot after that particular input.
To flag a conversation, click the flag icon corresponding to each conversation logs, or select the log and click Filters > Flagged conversations > Flagged > Apply filter.

After flagging, you can revisit the conversation on the current or next day by searching for flagged conversations in the filter.
In the Logs section, you can also view triggered events in any conversation. For example, if a "callbackStatus" event is triggered, click the Debugger icon, then click on the event to see details about the data the bot receives and the actions it takes after the event.

To access Audit Logs, follow these steps: