Session Replay - SDK Documentation on the docs site #5903
Description
Core or SDK?
Platform/SDK
Which part? Which one?
Session Replay SDK documentation needs to be included in the following existing areas on our docs site (see existing sdk specific snippets here):
- @sentry/browser
- @sentry/angular
- @sentry/ember
- @sentry/react
- @sentry/svelte
- @sentry/vue
- @sentry/gatsby
- @sentry/nextjs
- @sentry/remix
Description
Session Replay is a new product that is going to market in FY'24 Q1. Session Replay requires the installation of any of the SDKs mentioned above, as well as the @sentry/replay package. Installing the package requires users to also set sampling rates and general privacy settings.
Additionally, there are a number of optional configuration options that users can leverage (re: general integration, privacy, optimization and rrweb).
This is the ideal SDK documentation state for Session Replay. We are doing some temporary SDK doc changes for the second cohort we're enabling on Mon. Dec. 12th for closed beta.
This does not cover Product Guide documentation.
Suggested Checklist of Docs to Create or Update
(multiple issues can be created from this one)
New pages
- Dedicated section titled "Session Replay", similar to what is seen for "Performance Monitoring", in the browser SDK. This can come after the "Performance Monitoring" section.
- First page under the section is titled "Set up Session Replay" and includes "Pre-requisites", "Installation", "Set up", "Sessions", "Sampling", and "Error Linking" from our README, and "Verify" section if applicable.
- Second page under the section is titled "Custom Instrumentation" and includes two subpages - one for general configs "Identifying Users", "Start and Stop Recording", "General Integration Configuration", "Optimization Configuration", and "rrweb Configuration" from our README.
- The second subpage under "Custom Instrumentation" will be dedicated to privacy configs and examples. It will cover the table titled "Privacy configuration" and all the Privacy config examples with images seen in our README.
- Add a beta note as seen in other docs to all of the above pages.
Repeat dedicated section titled "Session Replay" and the above checklist items in other applicable framework SDKs with any framework-specific quirks worth noting:
- @sentry/angular
- @sentry/ember
- @sentry/react
- @sentry/svelte
- @sentry/vue
- @sentry/gatsby
- @sentry/nextjs
- @sentry/remix
Existing pages
- For @sentry/browser: Mention Session Replay CDN Bundles in Installation Methods > CDN
- For all applicable SDKs: Provide examples of Session Replay CDN bundles on the Pluggable Integrations page
- For all applicable SDKs: Add "Set up Session Replay" in the "Next Steps" as the last link on the "Getting Started" pages, taking the user to the dedicated Session Replay section
- For @sentry/remix, @sentry/nextjs: Add "Session Replay" in the Features list on the "Getting Started" page
- For all applicable SDKs: On the "Identify Users" page, mention that this setting applies to how users are identified in Session Replay