Including Pre-Baked Metadata

Normally clients have their own application specific metadata to add to a recording in order to identify and later retrieve the recording. See capturing application metadata on how to associate this.

If you want to let rrwebcloud handle storage of basic data of this nature, then set the config.includePii option to true. As this option potentially includes personally identifiable information, it is off by default. When it is turned on, the folllowing data is associated with each recording:

Visitor ID	A visitor ID. This is generated in the browser and stored in the rrweb-cloud-visitor-id first party cookie. Unlike the recordingID, which is stored in sessionStorage, this is set to be stored for up to a year and refreshed on each page load (although in practice browsers clear cookies more regularly than that). It is useful to be able to replay multi-tab recordings, and to show recordings from the same visitor from multiple recordings separated by a longer time period. From an analytics point of view, this cookie is needed to calculate unique visitors over a given time period, a key metric (although the cookie method cannot discount the same visitor using multiple devices)
Document Referrer	associated with a page view. Can be used to determine which website or search engine referred the visitor to the website being recorded
IP Address	The ip address from which the browser connected to the rrweb cloud server. Note: the visitor may be using a proxy which will make the IP inaccurate
User Agent	To indicate which browser the recording was made with, useful for attributing browser display issues during replay
Language	Useful in aggregate to determine your visitors language preferences. E.g. en_NZ English (New Zealand)
Timezone	Can be used to categorize and broadly geolocate your users
Screen	Screen width, height and device pixel ratio. This is distinct from the viewport width/height captured in rrweb to replay a recording correctly.

These fields may in future be used as the basis of an analytics dashboard, e.g. by looking up countries from IP Addresses we'll be able to show you the most popular countries for your visitor cohort.

Note: this is distinct from PII which may appear within the recording itself (e.g. form fields etc.). See blockClass / blockSelector from the rrweb documentation. (TLDR: add a rr-block class to any HTML item which you wish to explicitly exclude from a recording)