Troubleshooting Flows

As any developer knows, the more tools you have to debug your application, the better. Descope knows this and enables you to debug your flows in several ways. This article will cover the various tools Descope provides for troubleshooting your flows.

Client SDK Debug Mode

Under the Getting Started Guide for each of the SDK/Frameworks, you will see there is a debug option built into every Flow component. Below is an example of the debugging modal when enabled within the Descope client SDK.

Flow Runner

You can debug your flow by running it in the Descope flow runner, which writes error messages and debugging statements for connectors to the Runner messages. To run a flow within the Descope flow runner, navigate to Flows and choose your flow, then click the blue Run button at the top right. Below is an example of the data written to the runner messages.

Troubleshooting Logs

Descope also allows you to view flow logging within the Troubleshooting Logs section of the Descope console; this is very helpful for troubleshooting issues reported by your end users as you can see the history of errors that occurred within your flow. These logs will include failures in your Descope flow, including any errors related to Descope actions such as connector actions, sign-in/up/up or in actions, etc. The errors displayed here will show you the error details, including the step name, similar to what you see in the flow runner. When it comes to connectors, the complete error response from the connector is logged to enable you to troubleshoot the behavior of your connector.

Similarly to audit streaming, you can stream flow troubleshooting logs via the audit stream connectors by checking the box for Stream Troubleshooting Events.

Below is an example of the details logged to the troubleshooting logs within Descope.