If you run into an issue while recording with the Replay Browser, these tips can help identify the issue. If you have any questions or get stuck, donโt hesitate to contact us.
The Replay Browser is not required to view replays. Replay URLs can be opened in any browser of your choice.
Updating the Replay BrowserChecking Replay's Build IDChecking the Browser ConsoleCollecting Data for Login IssuesChecking Mac ConfigurationImporting SSL CertificateReplay crashes during long recordingsRecording applications with WebGLRecording multi-window applicationReplay can't be openedViewing browser crashesCreating a New ProfileVerbose Logging
Updating the Replay Browser
There are three ways to update Replay.
- Quit and re-open Replay.
- Click on the green arrow in the top right.
- Go to Replay > About Replay.
Checking Replay's Build ID
To check if Replay is up-to-date or to get the Build ID for a bug report, go to Replay > About Replay. The Build ID corresponds to the
<year><month><day><time> of the buildโs release.
Checking the Browser Console
When the browser fails while recording, the exception will likely be logged to the Browser Console.
As a little bit of context, we built Replay's recorder is written in C++, but most of the logic for starting, stopping, and saving is in JavaScript. This means that most exceptions will bubble up to the console where we can pretty easily identify it and fix it.
The Browser Console is available at Tools > Web Developer > Browser Console.
Collecting Data for Login Issues
- Launch Replay and open the browser toolbox. This will open a new window with standard devtools (but connected to the browser instead of the current web page)
- Click the "Sign in" button and walk through the auth steps
- After you complete the authentication in your preferred browser, return to the Replay browser's browser toolbox window and check for errors in the console.
- Switch to the network tab and select Save All as HAR from the settings menu to download your network requests. This will help us correlate your auth attempts with our logs. You can send that to via DM in Discord or to support@replay.io.
Checking Mac Configuration
Because Replay records at the system level, small differences between Operating System versions and processors could make a difference. If Replay crashes or is slow, check version of the Mac OS is running and the processors on your computer to make sure they are up to date and when submitting a bug report.
Importing SSL Certificate
If your organization uses custom certificates or you generate a certificate for local development, you may need to import it into the Replay Browser in order to make recordings.
Importing SSL CertificateReplay crashes during long recordings
We recommend limiting Replay recordings to 2 minutes in length โ the shorter, the better. We are working on increasing the length of time Replay can record continuously and maintain performance.
Recording applications with WebGL
Replay currently does not support recording applications with WebGL, and may experience errors. You can follow the GitHub issue here for updates.
Recording multi-window application
Recording applications which use multiple windows is partially supported. When viewing a replay of a multi-window application, only graphics from one window will be shown, but you can still debug the code that executing in all windows.
Replay can't be opened
This message appears if we fail to notarize a version of Replay. Please let us know and we will fix it. If you would like to bypass this warning instead you can follow the steps here.
Viewing browser crashes
Visit
about:crashes while in the Replay Browser to see if a browser crash has already been reported to our servers. Any crashes in the โUnsubmitted Crash Reportsโ section should be re-submitted using the โSubmit Allโ button.Browser crashes are also written to a text file which can be viewed locally.
Creating a New Profile
Sometimes it can be helpful to try creating a new browser profile. This will effectively clear the browser settings.
To create a new profile, go to
about:profiles and click Create a New Profile.
Verbose Logging
It's possible to start the Replay Browser from the terminal with verbose mode enabled to view additional logs.
- Quit Replay.
- Open the terminal and run the command below.
- Perform the action that was causing the issue.
- Quit Replay.
bashRECORD_REPLAY_VERBOSE=1 /Applications/Replay.app/Contents/MacOS/replay
This will output detailed logs that can be submitted to our team along with a bug report.
