Skip to main content
All CollectionsTesting & Troubleshooting
Understanding the Debugger Console tool
Understanding the Debugger Console tool

Learn how to debug your Chameleon Experiences from your browser.

Tiago Mota avatar
Written by Tiago Mota
Updated over a week ago

Wondering why your Experience is not showing up as expected? Use Chameleon's Debugger tool in the browser console to get detailed information about why Experiences might not show up.

It will show you if the user is in the target audience for that Experience, if the Experience is being Rate Limited, and more. Use this to quickly track and solve issues and fast-track your Experiences to success.

Simply provide the command with the ‘Experience ID’ found in the URL of the Dashboard, chmln.debug('629f6c73f4ac75001836b38q'), or run the command by itself to see details for all Experiences: chmln.debug().


Availability & Usage

🔐 Available for all plans

📍 For accurate display info on Tours, Tooltips, Embeddables, Microsurveys, Launchers

⚙️ Use from your browser console


How to access the Debugger

You can use the Debugger in your browser console. To open the console in most browsers, right-click your app and go to "inspect", and then click on the "console" tab. The shortcut for Chrome on Mac is cmd+opt+J.

If you're not familiar with the console, you can always check the Chrome Extension for the shortcut to open it and to copy/paste the command you should run in your console.

Click the Chameleon Chrome Extension → copy the Debugger command → use the shortcut to open the console → paste it into the console and hit "Enter".

Next, you will see the list of Chameleon Experiences that are live and you can search for a specific Experience to check why it may not be displaying.

The debugger has two commands available, depending upon what stage of loading Chameleon has been completed: chmln.debug() or chmln.Snippet.debug() (to check if the Chameleon snippet is correctly installed)

Check if Chameleon is installed properly

Use the chmln.Snippet.debug() to test if Chameleon has been installed correctly and that the snippet is working properly.

If this debug message returns a positive message, such as "Chameleon loaded, User profile loaded," then proceed to use chmln.debug() to test Chameleon Experience status.

Check the status of all published Experiences

When you run chmln.debug(), you will see a list of all the Experiences that have been published in your account. Click the arrow > next to an Experience to see details on its display state, what segment is used for the Target Audience, and which step it's on.

You can also see the Variant label and ID (if the Tour or Banner is part of an A/B test) or any excluded Segments from the audience.

Debugging a specific Experience

You can debug a specific Experience, by including its ID in your debug call. Such as chmln.debug("60cb861eb6ef93001b8d731e").

You can grab the Experience ID directly from the console from the drop-down menu of the Experiences listed in the console.

Or you may find the Experience ID in the Chameleon Dashboard. When you open an Experience's page you will see its ID from the URL, for example, app.chameleon.io/tours/629f1bdd19fc2d00136ca576.

Why doesn't my Experience show up on the list?

The list displayed when you run is of all published Experiences. If you do not see an Experience listed, please open the Experience in the Dashboard to get the Experience ID and then run the command for that Experience. Most likely, the Experience isn't published, and you'll see a message like this.

While you're in the dashboard, you can also see the state of your Experience. If you do not see the green "Live" badge next to the title, this also tells you that it isn't published and shown live to other users.


How to interpret the results

Now that you've gotten the results of your Experience, here's more information about what each message means. If you expect an Experience to display but it isn't, this will help you figure out how to resolve that.

Error phrase

Explanation

How to resolve

Chameleon not loaded

Chameleon has not been installed or initialized correctly.

Review Chameleon's install documents and ensure both the Chameleon snippet and identify commands are installed correctly.

User profile not loaded

No user has been identified to Chameleon, or the user profile has failed to load.

Review Chameleon's install documents and ensure the identify command is installed correctly.

Chameleon is disabled

Chameleon's elusive setting has been enabled on the Chameleon Snippet.

Check to make sure the elusive setting is enabled for the expected users.

Domain disabled

The current domain has been disabled.

Enable the domain on the domains page.

Chameleon Cleared

Chameleon was initialized, and then chmln.clear() was run, which cleared it from the page.

Talk to your development team to make sure that chmln.clear() is run in your app at the appropriate time.

Something unique went wrong

Something that's not obvious went wrong.

Contact Chameleon Support for more help.

More Messages

The errors below are self-explanatory and usually very easy to resolve when seen. But we are here to help out if you have any questions. We will also update this article with additional context.

  • Current user UID "[uid]" is within the Target Audience, Experience can be displayed to you when all conditions are met and no other Experience is showing.

  • Current user UID "{uid}" is not within the Target Audience, Experience will not be displayed to you.

  • Current user UID "[uid]" started this Experience but is no longer within the Target Audience. After it is exited or completed it will not show again.

  • Control group test being run on this Experience, Current user UID "[uid]" is not in the test group and will not see the Experience.

  • Control group test being run on this Experience, Current user UID "{uid}" is in the test group and can see the Experience when other conditions are met.

  • Current user UID "{uid}" is within the Target Audience, but Control group test being run on this Experience, Current user UID "{uid}" is not in the test group and will not see the Experience.

  • Current user UID "{uid}" is within the Target Audience, Experience can be displayed to you when all conditions are met and no other Experience is showing.

  • Current user UID "{uid}" is in the test group and can see the Experience when other conditions are met.

  • Current user UID "{uid}" is not within the Target Audience, Experience will not be displayed to you.

  • Experience would be able to display here, but is rate limited. (See your Rate Limiting page in the Dashboard, and learn more here).

  • Completed Survey, but finishing extra comments or thank-you.

  • Experience was recently triggered by an action on a previous Experience, short-link URL, or a call from the API.

  • Experience can be manually started by an action on an Experience, short-link URL, or a call from the API.

  • Experience has been Completed.

  • Experience has been Exited.

  • Experience is not displayed but will reappear based on next recurrence setting.

  • Experience has been Exited and will reappear after snooze time period ends.

  • Experience queued to be shown after other Experience(s) finish.

  • Experience\'s URL Rules do not apply to the URL of the current page.

  • Experience\'s selected anchor element is not on the current page.

  • Experience\'s trigger element/icon is either not on the current page or is on the page but has not been interacted with yet.

  • Experience has a Timed Delay set, and that time has not expired yet.

  • Experience requires a selected element to be present on the page, still checking for the element.

  • Experience required a selected element to be present, the time has expired and element was not on the page.

  • Experience requires a selected element to be absent from the page, timer still counting down before checking.

  • Experience requires a selected element to be absent from the page, the time has expired and element was still on the page.

  • [Experience] Title: "[name]" is being displayed on the page.

  • There is no published (aka live) Experience with ID '[uid']. Open the Experience from the Chameleon Dashboard, confirm the ID at the end of the URL, and also that the Experience is live.

  • If you're seeing a Launcher and the status is blank, the Tours inside may be unpublished.

  • Now displaying, no other Experiences can Display.

Note you'll also see if your Experiences are not displaying because of a Smart delay (because the user has interacted with another Chameleon Experience before on the same session, or because of the built-in 60-sec delay) or if it's waiting on the Timed delay to end (and another Experience is displayed instead).

📩 If you need any further help feel free to contact us with questions.

Did this answer your question?