Use the mobile debugger

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 needing 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're signed in to 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

To access the mobile debugger:

1. In the left-side menu, go to Settings > Mobile debugger. This option is only available if you have a mobile app integrated into your subscription. 
2. In the Select an app dialog box, select an app from the dropdown list and select Next. The Events tab of the debugger displays. If you need to connect your mobile device, the Connect a device dialog box displays. See Use the debugger below.

Use the debugger

After accessing the debugger, you can connect your device to it. A dialog box displays prompting you to connect your device. You can connect by scanning the QR code or, if you aren’t able to use your device's 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 that you have a valid session and try again, ensuring that your application is launched and you're signed in to your application beforehand.

Example use cases for the debugger

Example use cases include:

• I'd like to see if Pendo recognizes Page view 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.

The table provides details of the actions you can take in each tab:

Icon	Details
	Relevant for events only. Matches events with Pages and Features that have been saved in your app.
	Delete items from the log or events list
	Copy items from the log or events list to an external file. You can select to copy all or select to copy an individual row in each tab.

Events

The Events tab displays analytic event types that are used to display analytic data in the Pendo UI. To filter the events, select an event type from the dropdown list in the top-right corner of the Events page.

Select an individual event to view more detailed information about it.  

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 initialization, 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 (for example, poor internet for downloading guide content or a guide image error) or another guide was higher in the guide ordering and 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 Visitor ID for a current session.
• AppSessionEnd. Sent when a new session ends or when setting a new Visitor ID, effectively ending the session of the previous Visitor ID. 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 an application to the background.
• AppInForeground. Sent when moving an 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 UI. You can filter these logs in the top-right corner of the Logs page. Logs are filtered by Warnings, Errors, Info, and Verbose, which is a collection of all logs together.

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.