Replay a GBC log

With the GBC, you can record a session log to capture the interaction between the front-end and the DVM, with the intent of using that log later to replay the session for debugging purposes, or to provide a demo of the application. A log can also be useful when reporting a support case that otherwise may be hard to describe or not obvious to re-create.

This topic covers the replay of the session log. For details on recording the session log, see Record a GBC log.

To replay a log with a specific customization, you must also have the customization.

Display the log player

To display the log player, open the application and include the logPlayer query string parameter in the application URL, with the value set to 1. For example: http://localhost:6394/ua/r/gwc-demo?logPlayer=1

The application must be the same application used when creating the session log.

NOTE: The replay takes into account the size of the browser window when the log was recorded. We replay the log in the same context it is recorded, to avoid having differences when trying to reproduce a potential issue. As a result, you may find that you need to scroll or resize your browser window when replaying a log.

Log player controls

The log player displays above the application.

app with log player shown

Log File

To load a log file, click the Select file button and select the session log.

Once the session log is loaded, an informational page displays telling you many details about the environment at the time the session log was recorded. It displays the file name, GBC details (version, theme used, and so on), Browser details (type, OS, and so on), and the settings of every Theme Variables at the time the session log was recorded, and the values of the Stored Settings.

You can also hover over the Select file button to view information about which log file has been loaded.

Controls / Go to Step

The four buttons under the Controls label do the following:

  • Reset - If you have been playing or stepping through the log, the reset button allows you to start from the beginning.
  • Next Step - Rather than play the log, you can step through the log one step at a time.
  • Play - Play the log, moving between steps as defined by the Delay section (see below).
  • Pause - Pause the replay of the log.

The Go to Step field allows you to skip to a specific step. Enter in the step number and click the double-arrow icon.

NOTE If you have paused the log replay, you will find that you can interact with the application interface; however you are not truly interacting with the application as there is no DVM. When you resume the log replay, it will pick up where it stopped, ignoring any of the clicking you may have done in the interface.

Statistics

The Statistics switch allows you to enable or disable statistics. If you enable statistics, you can get information about the DOM state and the number of widgets remaining in the application at the end of the log. The statistics displayed are not intended for analysis by the casual user; it is mainly provided for use by support, to provide information that may be useful when investigating performance issues or checking for memory leaks.

Delay / Use delay from log

By default, the Use delay from log switch is in the ON position, meaning that the timestamps recorded in the session log will be used to determine when to move from one step to the next. The replay will happen following the same timings that the user took when recording the log.

The Delay field allows you to specify, in milliseconds, the time between steps when replaying a log. The delay interval is only used when the Use delay from log switch is in the OFF position.

Show interactions helpers

The Show interactions helpers shows the user interactions that may not appear on the application itself. For example:

Mouse movement and mouse clicks

While you can follow the mouse movements in the application interface, you need more information to determine whether the right or left mouse button has been clicked. The right and left arrows that display in the interactions helpers section tell you whether the user clicked the left or right mouse buttons. Touch events, middle click and mousewheel events are not displayed here.

In this screen shot, the mouse is being used but there is no mouse click. show interactions mouse clicks with neither selected

In this screen shot, the mouse is being used and the left mouse button has been clicked. When a left or right mouse button is clicked, the arrow becomes stronger and is more pronounced. show interactions mouse clicks with neither selected

Key strokes and data entry

When you are looking at the application interface, the keys that the user presses are not shown. This includes the data that the user may be entering into a field. You can, however, see what keys the user pressed by looking at the interaction helpers. Key combinations are displayed.

In this screen shot, the user was in a field when they pressed the 2 key: show interactions key stroke of 2

In this screen shot, the user pressed the RETURN key: show interactions key stroke of 2

See also Record a GBC log.