Documentation Index

Fetch the complete documentation index at: https://docs.darwinium.com/llms.txt

Use this file to discover all available pages before exploring further.

Debugging Journeys

  • Updated on Jul 31, 2023
  • Published on Jul 31, 2023
  • 2 minute(s) read
  • BD
 Prev Next
Early release
Note - the tools outlined in this guide are early-release versions of functionality that will be deeply integrated into our authoring environment at a later date. They may occasionally produce unexpected errors. Please contact Darwinium support if there is an error that persists in the use of these tools.


Darwinium's workflow editor includes some useful utilities that provide live feedback and debugging on the journey you are authoring. 


To use these, open a terminal window in the workflows editor by using the keyboard shortcut:


The following commands are available:

dwn_journey_checker

Journey checker provides the user with feedback on any errors that may be contained within the journey. It is also used internally when pushing to a repo - if the tool fails, you are required to fix any errors prior to a push being accepted.

Information is returned in a tabular format outlining where in your source file an error exists, along with suggestions on how this may be resolved.


dwn_journey_debugger

The journey debugger provides the ability to compile your journey logic, and test it using the journey assistant proxy, prior to deploying your journey. This enables you to check for any errors in your logic in a single-user mode prior to deploying to the edge. 

Journey debugger is best run against a 'naked' origin
Journey debugger does not currently account for the fact that there may already be Darwinium journeys operating on your site already. It is therefore highly recommended that you author journeys against an un-modified version of your site (i.e. the underlying origin) 



Prerequisites

In order to use the debugger forward proxy, you will need the Darwinium root certificate and proxy setup. Instructions on how to do this are provided in Journey Assistant.

Operation

1. Start the journey debugger by running dwn_journey_debugger. You will be presented with a screen similar to the following:

2. Open your web browser with proxy configured (see Journey Assistant) and enter darwinium as the username and the uniqueToken value as your password

3. Type build ↵  into the console where dwn_journey_debugger is running. An inline build will commence and your journey will be uploaded to the proxy server:

4. Navigate to a URL covered by a step in one of your journey. For each step covered, you should see live event data:

5. Make any changes to your journey and type build ↵ again to propagate this to the proxy server. Reload your page to see updated event data. Repeat the process until you are happy with your journey

6. Use ctrl-c to quit the debugger, or close the terminal when you are done