Debugging the Braze SDK

Learn how to use the Braze SDK’s built-in debugger, so you can troubleshoot issues for your SDK-powered channels, without needing to enable verbose logging in your app.

Prerequisites

To use the Braze SDK debugger, either ensure your native SDKs are up to date with at least these minimum versions, or your wrapper SDKs point to these minimum versions:

To enable debugging for the Braze Web SDK, you can use a URL parameter instead.

Debugging the Braze SDK

Step 1: Close your app

Before you start your debugging session, close the app that’s currently experiencing issues. You can relaunch the app at the start of your session.

Step 2: Create a debugging session

In Braze, go to Settings, then under Setup and Testing, select SDK Debugger.

Select Create debugging session.

Step 3: Select a user

Search for a user using their email address, external_id, user alias, or push token. When you’re ready to start your session, select Select User.

Step 4: Relaunch the app

First, launch the app and confirm that your device is paired. If the pairing is successful, relaunch your app—this will ensure that app’s initialization logs are fully captured.

Step 5: Complete the reproduction steps

After relaunching your app, follow the steps to reproduce the error.

Step 6: End your session

When you’re finished with your reproduction steps, select End Session > Close.

Step 7: Share or export your session (optional)

After your session, you can export your session logs as a CSV file. Additionally, others can use your Session ID to search for your debug session, so you don’t need to send them your logs directly.