If your Guide isn't displaying as expected in your staging or production environment, you can use the Debugger tool to troubleshoot the issue. This article walks you through how to start up our Debugger tool and use it to troubleshoot Guide display issues.
Load the Debugger
- In Pendo Engage, right-click on your web app page and select Inspect.
- This opens up the browser developer tools. Find the console tab, open it, and enter
pendo.enableDebugging(). To disable the debugger later, you can use
- A pink bug icon appears in the top-left corner of your screen. Select it to open the debugger.
- The debugger loads as a side navigation bar in your browser. It consists of several sections. The sections Agent, Guides, Throttling, and Resource Center are covered below.
The Agent section shows a variety of data, such as subscription settings and current Visitor information, useful for both Guide troubleshooting and installation verification.
- Check the Visitor and Account metadata that your application is passing into Pendo for the current Visitor. Ensure that the metadata values fit within the segment applied to the Guide you're testing.
You can also use this to find your current Visitor ID and create a segment that applies to just your Visitor ID so you can test Guides in production without anyone else seeing them.
- Ensure that your Guide is set to the correct environment for your current testing (production or staging environment). If the Guide is in production, it also shows up in staging environments.
- Check that you have the right API key. The API Key is specific to your Pendo app. To check that you have the right one, go to Settings > Subscription Settings > View App Details, and then find and check the API key under Basic Settings.
If it does match and you have a multi-app subscription, go to the Guides page in the left-side navigation, and find your Guide in the App column to see if it's registered under the app you just verified the API key for.
- Test your Page rules.
The Current URL is the normalized URL that Pendo recognizes from the page you are on. If your guide is set to a specific page, copy the Current URL in the Debugger, go to Pages in Pendo, and select the Page your Guide is set to. There should be at least one Rule for that Page
Select Test Rule to the right of each Page Rule. In Test URL, paste the Current URL from the debugger. If the Current URL doesn't match any of the Page Rules, then the page you are on with the debugger loaded, doesn't fit the Page you have the Guide set to.
For more information about URLs and Page tagging, see URLs for Page tagging.
The Guides section shows two lists: Active Guides and Excluded Guides.
- Active Guides are all the Guides available to the current Visitor based on Page and Segment. If the Guide you're expecting to load is in this list, your current Visitor fits the segment of the Guide and the URL you are on matches the Page the Guide is set to.
- Excluded Guides are all the Guides not eligible for the current visitor. A reason for this is displayed below each one in the list, as seen below. Reasons could be that the current Visitor doesn't fit in the segment, or the current URL doesn't match any step's set location for that particular Guide.
If the Guide is not in the Excluded Guides list and you are unsure why it isn't displaying, select the plus sign (+) next to the Guide to see the Guide details.
The Guide details are followed by information associated with each step of the Guide. Here are a few things to check in both the Guide details and step sections:
- Is the Launched field set to Automatic and Has Been Seen is True?
This means the Guide won't display because Automatic activation means you only see it once until it's dismissed. For more information about activation settings, see Guide Activation Options – Visual Design Studio.
- Does Launched include either Badge or Dom (target element activation), but in the details under Step 1, Element says not visible in red?
This means Pendo can't find the element the Guide is tagged to on the current page. If you see the element on the page, try retagging the element inside the Pendo designer or, if you're comfortable with CSS and HTML, you can find the element in the DOM and verify that it fits the CSS selector.
We also have a function
pendo.Sizzle('CSSselector')you can use in the console to find out whether the CSS selector fits any elements on the page. If it fits multiple, Pendo attaches the Guide to the first element in the DOM.
- Does the Guide start as expected but one of the steps doesn't appear?
Restart the Guide and advance until you reach the step that comes before the step that doesn't show up. Look at the Guide details in the Debugger, specifically the next step details, to see if the element or page settings match for the next Guide step. These show in red if they don't match.
To check the element settings see the answer to 2 above. To check the page settings, see the troubleshooting tips for the Current URL info in the Agent tab of the Debugger above.
- If the above don't resolve your Guide not displaying and your Guide is set to automatic, it could be due to Throttling and Guide order.
Throttling and Guide order
The Throttling tab shows you if you have throttling set up, its settings, and your Guide order. These can also be seen by going to Guides > Ordering.
If throttling is enabled and your Guide is set to automatic activation, then the Guide won't display until after that throttling time period is fulfilled.
If you don't see the Guide at the top of the Guide order list and it's set to automatic activation, then the Guide won't display until the automatic Guides above it in the order have been seen first.
For more information, see Guide ordering and throttling.
The Resource Center tab looks similar to the Guides tab. The first block is the Home View, which is the first thing you see when you open the Resource Center. Each block thereafter corresponds to a module inside of your Resource Center.
For troubleshooting Guide display issues in the Resource Center, first identify the Onboarding or Guide List module in the Resource Center tab of the debugger.
Is Has Content set to False?
This means that the module has no Guides eligible for view. Check if the Guide is listed under the Children header.
If the Guide is in the list, and it says it's in the payload, check that the segment applied to the module applies to the Visitor metadata in the Agent tab.
If the Guide is in the list, and it says it isn't in the payload, go to the Agent tab to troubleshoot further.
If the Guide isn't in the list, go to your Resource Center in Pendo, and check that the Guide is in that module, and that it's been pushed to the appropriate environment (staging or production).
If you're still having issues after going through this checklist, you can Get help with Pendo from Technical Support.
Disable the Debugger
Don't forget to turn off the debugger when you're done. You can do this by entering
pendo.disableDebugging() in the developer tools console.