Set Up
Learn which SDKs support Session Replay and start sending replays to Sentry.
If you have any questions, feedback or would like to report a bug, please open a GitHub issue with a link to a relevant replay or, if possible, a publicly accessible URL to the page you're attempting to record a replay of.
With Session Replay, Sentry users can get to the root of an error or performance issue faster, by watching a video-like reproduction of a user session and getting additional information such as what would appear in the developer tools of a client browser.
To get instructions for how to set it up and start sending replays, click a link for one of the supported SDKs below.
Session Replay supports all browser-based applications. This includes static websites, single-page-aplications and also server-side-rendered, that includes frameworks such as: Django, Spring, ASP.NET, Laravel, Express and Rails. If you don't use npm
or yarn
, you can use our Loader script
tag on your main HTML template.
The Sentry SDK that records the replay runs on the client's browser, and it’s built-in to @sentry/browser
and our browser framework SDKs:
Replays are integrated with Sentry's tracing data model, enabling you to see replays associated with backend errors. For these replays, you'll be able to view backend errors in the Timeline, Breadcrumbs, Errors tab, and other places when you go to the Replay Details view. You'll also see a Replays tab and replay previews in the Issue Details page for any backend error that has a linked replay.
To see replays for backend errors, you need to have Sentry set up for both your frontend and backend, along with distributed tracing. This provides end-to-end data connectivity on your APIs, allowing Sentry to link replays to backend endpoints. Make sure you've set up trace propagation in your backend projects. For example:
Sentry.init({
tracePropagationTargets: [
'third-party-site.com',
/^https:\/\/yourserver\.io\/api/,
],
});
Currently, replays for backend errors is supported for the following SDK versions or newer:
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").