-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8189 from braze-inc/develop
Deploy - October 1, 2024
- Loading branch information
Showing
457 changed files
with
6,030 additions
and
4,796 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
--- | ||
nav_title: SDK Debugging | ||
article_title: Debugging the Braze SDK | ||
description: "Learn how to use the Braze SDK debugger, so you can troubleshoot issues for your SDK-powered channels, without enabling verbose logging in your app manually." | ||
page_order: 3 | ||
--- | ||
|
||
# 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. | ||
{% alert important %} | ||
Currently, this feature is only available for native iOS and Android apps. To enable debugging for the Braze Web SDK, you can [use a URL parameter]({{site.baseurl}}/developer_guide/platform_integration_guides/web/initial_sdk_setup/#logging) instead. | ||
{% endalert %} | ||
|
||
## Prerequisites | ||
|
||
To use the Braze SDK debugger, ensure your SDKs are up to date with at least these minimum versions: | ||
|
||
{% sdk_min_versions swift:10.2.0 android:32.1.0 %} | ||
|
||
## 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**. | ||
|
||
![The "Setup and Testing" section with "SDK Debugger" highlighted.]({% image_buster /assets/img/sdk_debugger/select_sdk_debugger.png %}) | ||
|
||
Select **Create debugging session**. | ||
|
||
![The "SDK Debugger" page.]({% image_buster /assets/img/sdk_debugger/select_create_debugging_session.png %}) | ||
|
||
### 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**. | ||
|
||
![The debugging page for the selected user.]({% image_buster /assets/img/sdk_debugger/search_and_select_user.png %}){: style="max-width:85%;"} | ||
|
||
### 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. | ||
|
||
{% alert tip %} | ||
When you're reproducing the error, be sure to follow the reproduction steps as closely as possible, so you can create [quality logs](#step-6-export-your-session-logs-optional). | ||
{% endalert %} | ||
|
||
### Step 6: End your session | ||
|
||
When you're finished with your reproduction steps, select **End Session** > **Close**. | ||
|
||
![The debugging session showing the "End Session" button.]({% image_buster /assets/img/sdk_debugger/close_debugging_session.png %}){: style="max-width:85%;"} | ||
|
||
{% alert note %} | ||
It may take a few minutes to generate your logs depending on your session length and network connectivity. | ||
{% endalert %} | ||
|
||
### 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. | ||
|
||
![The debugging page with "Export Logs" and "Copy Session ID" shown after the session.]({% image_buster /assets/img/sdk_debugger/copy_id_and_export_logs.png %}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
page_order: 1 | ||
page_order: 0 | ||
nav_title: Getting Started | ||
article_title: Getting Started | ||
layout: dev_guide | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.