Documentation / Using CloseYourIt

Session replay

Record how people move through the site and watch it back like a video, even next to an error.

Session replay records how people move through your site and gives it back to you as a video. It helps when a report cannot be reproduced: instead of rebuilding the steps in words, you watch them.

Turn on recordings

You need two things together: the switch on the project and the code in the pages. With only one of them no session arrives, and nobody tells you.

The project must have the Web platform: sessions are recorded only there.
In the project Settings turn on Record sessions.
Paste this code in the site pages, inside the head:

<script src="https://cdn.jsdelivr.net/npm/rrweb@2/umd/rrweb.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@bussolabs/closeyourit-js@0/dist/closeyourit.min.js"></script>
<script>
  CloseYourIt.init({
    endpointUrl: "https://bugs.example.com",
    publicKey: "<project public key>",
    projectId: "<project id>",
    environment: "production",
    replay: true,
  })
</script>

The first line loads the part that actually records. Without it, the rest keeps working and the recordings do not, silently. Keep it before the others.

The in-app guide gives you the same code already filled in for the project you pick. The other SDK options are in JavaScript.

What stays hidden

Recording starts already masked. It covers both what the person types and what the page shows them:

Option	Default	What it does
`replayMaskAllInputs`	`true`	masks the content of every form field
`replayMaskTextSelector`	`"*"`	masks the text of every element on the page
`replayBlockSelector`	none	leaves the matching elements out entirely: they are not recorded

To see text in clear you pass a narrower selector. With replayMaskTextSelector: ".private" only what has the private class stays masked; everything else shows.

CloseYourIt.init({
  // ...
  replay: true,
  replayMaskTextSelector: ".private",
  replayBlockSelector: ".payment",
})

A recording cannot be fixed afterwards: data recorded in clear goes away only by deleting the recording. Widen the clear text only where you are sure.

Of the person who browsed, only an anonymous fingerprint stays, not their name or email. It tells you two sessions belong to the same person, not who they are.

Find a session

The Session replay page lists sessions from the most recent. For each one you see project, user, entry page, number of errors, length and start.

Filter by Project and Environment.
Search by entry page.
In the Errors filter pick With errors only to see the sessions where something went wrong.

Opening a session you watch it like a video, with the pages visited and the errors that happened along the way.

From the error to the recording

On the page of an error, below the occurrence details, there is the Session replay box: the session in which the error happened. From there you see what the person was doing before the failure, without looking for the session by hand. In the list of occurrences a symbol marks the ones that have a recording.

If the box says there is no recording, it is not a fault: recording was not on, or the error does not come from someone browsing the site.

Help desk requests carry the same visit too: in the request you see the errors that happened to the person who wrote.

How long they stay

Recordings are kept for 30 days. Then they are really deleted, video included.