Back

Trace is a testing and inspection tool for your EventStream and AudienceStream configuration that allows you to capture your workflow as a visitor and watch how events and customer data are processed in real-time.

This article describes how to start and stop a new trace, join an active trace, and view the overview panel and trace log. 

In this article:

Prerequisites

The following items are required to use Trace:

  • EventStream or AudienceStream
    If you do not already have access to one or both, contact your account manager to activate.
  • Tealium Tools Browser Extension
    Tealium Tools is needed to start and end a trace session in your browser.

How It Works

Trace provides an inside view into the inner workings of EventStream and AudienceStream. The trace tool is critical for testing your configuration. You can use trace to observe the details of a predefined workflow, ensure that attributes update correctly, rules are correctly applied, and that actions trigger as expected.

From the Trace interface, you can:

  • Start or stop a trace
  • Join an active trace
  • View predefined workflows and event log details in real time
  • Establish rules and view results
  • Get replay code to replay, pause, or resume an event
  • View a scrolling summary of actions, events, and audiences
  • View the details of an event or processing step
  • View snapshots of visitor profiles

Get a Trace ID

After you have saved your Customer Data Hub configuration and are ready to begin testing your enrichments, audiences, and actions, you need to get a Trace ID to use in the Trace tool.

Use the following steps to get a Trace ID:

  1. Go to Server-Side > Trace.
  2. Click Start.
    A Trace ID is displayed.
    WhiteUI_DataAccess_Trace_Getting a Trace ID.png
  3. Copy the Trace ID.
    The lifespan of a trace ID is 24 hours from time of issue.

Start a Trace

Use the following steps to start a trace:

  1. Open a new Chrome browser window and navigate to the first page of the workflow to test.
  2. Open the Tealium Tools browser plug-in and click AudienceStream Trace.
    WhiteUI_DataAccess_Trace_Starting a Trace_Tealium Tools_AudienceStream Trace.png
  3. Paste or enter the Trace ID.
    If you are tracing a session across multiple domains, deselect Trace me as a new visitor.
    WhiteUI_DataAccess_Trace_Starting a Trace_Tealium Tools_AudienceStream Trace_Start Trace.png
  4. Click Start Trace.
  5. Click Exit and then press ESC to exit the tool.
  6. Return to the Trace ID screen in Customer Data Hub, and click Continue.
    As you navigate through your workflow in the browser window, trace sends information to the Customer Data Hub and displays a timeline of visitor activity.  The trace screen provides a summary of the events, actions, and functions, as well as a detailed list of all events, actions, and functions. For example:
    trace-visitor-activity.png

Start or Join a Trace Using the Slide-Out Screen

If you have closed the trace screen, click Server-Side > Trace and the screen slides out again. You can use the trace screen to start or join a trace without leaving your current location in the product. When a trace is in progress, a blue arrow next to Server-Side > Trace pulses.  

Replaying Trace Events from the Trace Screen

From the trace screen, you can replay, pause, or resume an event by clicking one of the icons in the trace summary.

trace-icons.png

The following table provides details on each of the trace icons.

trace-icon-play-normal.png Play at normal speed. The default setting used to replay an event is normal speed.
trace-icon-play-2x.png Play at twice the normal speed.
trace-icon-pause.png Pause the ongoing trace. When paused, trace continues to process new events behind the scenes but does not display new log entries until you click pause again to restart.
trace-icon-view-profile.png View the latest visitor profile. Displays a snapshot of the profile for the latest visitor in JSON format. Click OK to exit this window.
trace-icon-get-code-replay.png Get code to replay events generates a curl command for each event. You can run the curl commands in a terminal window to replay an event in trace without having to recreate the configuration steps on the web page.
  • To replay a single event, copy and paste the matching curl command in the terminal window and press Enter to run the command.
  • To replay multiple events, click Download Bash Script to download the .sh file. Use the terminal window to run the .sh script.
trace-icon-exit-race.png  Exit the current trace. If the trace is still active on the web page, you can rejoin the trace using the Trace ID.

Viewing Event Details

The following image shows the parts of the trace interface. The Trace Log is a real-time scrolling summary of actions, events, and audiences. The Overview Panel displays a snapshot of the detailed activity. Search  can be used to find specific attributes in the list of visitor and visitor-scoped attributes. The attributes in the list are grouped by data type (Numbers, Dates, and so on). Filters can be used to filter these attributes.

trace-log-sections.png

Filters

Filtering allows you to determine if the attributes and the configurations tied to them are functioning properly. Using filters, you can choose how to view the attributes and their values. You can filter attributes by Label (if you have added labels for attributes) or by Type, where Type is one of the following 

  • All
    Shows all attribute types and values set up in your AudienceStream profile.
  • Existing
    Shows only the attributes that acquired a value after AudienceStream processing.
  • Modified
    Shows only the modified, or enriched, attributes.

Trace Log

In the trace log, clickable text is blue, other text is gray. The timestamp adjacent to the log entry displays the time of the log entry. To view the details of an event, click the blue event text to slide out a detailed view of the event.

You can minimize the trace window to continue the process while moving on to other feature of the UI.

Stop a Trace

Use the following steps to end an active trace and associated visitor session.

  1. Open a new Chrome browser window and navigate to your site.
  2. Open the Tealium Tools browser plug-in and click AudienceStream Trace.
  3. Verify the Current Domain and Current Trace ID of the trace you want to stop.
  4. Click Stop Trace.

Join an Active Trace

Use the following steps to join a trace that is currently in progress:

You must exit any active traces before you can join a trace.

  1. Click Server-Side > Trace.
  2. Click Join.
  3. Enter the known Trace ID for an active trace.
  4. Click Join.
    The trace log is displayed.
    WhiteUI_DataAccess_Trace_Get Started with Trace.png

Additional Information

Public