Use the mobile debugger

Last updated:

The mobile debugger tool is accessible to Pendo admins and lets you connect your application with Pendo, in the same way as you connect your device to the app for tagging pages. The debugger monitors events sent to Pendo in real-time. This is an alternative to using the setDebugMode() code level API, so you can monitor your events directly from the UI for troubleshooting purposes without the need to interact with the source code of your application.

Prerequisites

To connect to and use the UI debugger:

  • Make sure you have an established connection with Pendo’s server. Do this by calling PendoSDK.setup.
  • To see event analytics in the debugger after connecting, a valid session is needed, meaning the startSession()method must be called.
  • If you can’t connect or don’t see valid metadata in the UI, verify that you are logged into your application first, such that setup() and startSession() have been called in the installation flow before connecting your device.
  • The debugger requires an active session to work. Debugging issues that take place during or before the pendoSDK.setup phase of your installation requires using the debug API. For more information on using the debug API, see our mobile API documentation.

Access the mobile debugger

Subscription admins can access the debugger as follows:

  1. Navigate to Settings > Subscription Settings.
  2. In the Subscription settings page, select the Applications tab.
  3. Select the app you want to troubleshoot.
  4. In the App Details page, under Basic Bettings, select Debug.

Use the debugger

After accessing the debugger, you can connect your device to it. A modal prompting you to connect your device displays. You can also connect by scanning the QR code or, if you aren’t able to use your device camera, by copying the pairing link and pasting it into your device's browser. For more information, see Connect a mobile device.

If the device is paired successfully, a Pendo icon with a magnifying glass displays on your device’s screen.

If this icon doesn't show, or the magnifying glass isn't present, the device isn't connected or isn't in debug mode. Verify you have a valid session and try again, ensuring that your application is launched and you're logged in to your application beforehand.

Example use cases for the debugger

Example use cases include:

  • I'd like to see if Pendo recognizes the Page views and Feature click events.
  • I'd like to see what metadata is being added to my visitor at a certain point in my user journey.
  • I'd like to see if a track event is being sent when I expect it to.

Interpret information shown in the debugger

When your app has connected successfully, the debug tool displays three tabs, Logs, Events and Device Info. Each tab shows you different information about your current session.

Device info

The Device Info tab shows the current Visitor ID and Account ID, app version, and device information based on the most recent event received during the debug session. If the Visitor or Account IDs are missing, interact with the application to generate events. The Device Info page doesn't include the agent metadata values you've created.

Events

The Events tab displays analytic event types that are used to display analytic data in the Pendo One UI. You can select an event type to view the details for that event. Event types include:

Navigation Analytics:

  • RAScreenView. Sent when viewing a screen.
  • RAScreenLeft. Sent when leaving a screen (for example, moving to a different application screen).
  • RAClick. Sent when clicking an element.

Guide Analytics:

  • guideReceived. Sent on init, while there are guides defined for that segment.
  • guideSeen. Sent when a guide is displayed.
  • guideActivity. Sent when you click button - actions for example: "next step".
  • guideAdvanced. Sent when moving away from a guide step.
  • guideNotSeen. Sent when a segment eligible guide isn't displayed due to failure (poor internet for downloading guide content, guide image error, etc.) or another guide was higher in the guide ordering/throttling configuration.
  • guideDismissed. Sent when closing a guide or when it's automatically dismissed.
  • pollResponse. Sent when a poll response is provided by the visitor.
  • guideSnoozed. Sent when you select a guide button with the Snooze Guide action.

Other Analytics:

  • UpdateUserAttributes. Sent when setting new visitor metadata attributes.
  • UpdateAccountAttributes. Sent when setting new account metadata attributes.
  • AppSessionStart. Sent when a new session starts or when setting a new visitorId for a current session.
  • AppSessionEnd. Sent when a new session ends or when setting a new visitorId, effectively ending the session of the previous visitorId. This event could be sent during the next session, as the SDK doesn't send events if the application is closed.
  • AppInBackground. Sent when moving application to the background.
  • AppInForeground. Sent when moving application to the foreground.
  • TrackEvent. Sent when a track event occurs.

Logs

The Logs tab shows all SDK-related activity that's sent to Pendo, not just events that are related to the analytics shown in the Pendo One UI. You can filter these logs in the top right-hand corner of the Logs page. Logs are filtered by Warnings, Errors, Info, and Verbose - a collection of all logs together.

 

Was this article helpful?
0 out of 0 found this helpful