Initial Session Replay SDK Docs #5899

ryan953 · 2022-12-06T00:55:33Z

Relates to #5894
Relates to #5903

vercel · 2022-12-06T00:55:37Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
sentry-docs	✅ Ready (Inspect)	Visit Preview	Dec 7, 2022 at 5:24PM (UTC)

src/pages/index.tsx

src/platform-includes/performance/configure-sample-rate/javascript.electron.mdx

ryan953 · 2022-12-06T01:06:04Z

src/docs/product/session-replay/index.mdx

+---
+title: "Session Replay"
+sidebar_order: 3
+redirect_from:
+  - /session-replay/
+description: "Session Replay. TODO"
+---


New item in the sidebar of the Product section:

ryan953 · 2022-12-06T01:06:33Z

src/docs/product/session-replay/getting-started.mdx

+---
+title: Set Up
+sidebar_order: 1
+redirect_from:
+  - /session-replay/setup/
+  - /session-replay/getting-started/
+description: "Get started with Session Replay, TODO."
+---


Child page in the Product section:

I imagine Set Up is mainly a client-side/SDK thing? If so, we could probably get by without the sub page to start? Basically add all content on the landing Session Replay page for now

Ah just took a look at the "Performance Monitoring" section again, it looks like Ryan is following the pattern of what's done there. The "Set Up" just includes a list of links to the SDK docs and that makes sense to me. I wouldn't want to clutter product docs w/ installation instructions

yup! copy+pasted from Perf

I will pull these Product pages out of this PR and do them in a separate PR

Based on #5903 we don't have a specific product pages drafted yet (maybe faq?)

ryan953 · 2022-12-06T01:08:12Z

src/components/platformSidebar.tsx

+      <DynamicNav
+        root={`/${pathRoot}/session-replay`}
+        title="Session Replay"
+        prependLinks={[
+          [`/${pathRoot}/session-replay/`, "Set Up Session Replay"],
+        ]}
+        suppressMissing
+        tree={tree}
+      />


SDK nav:
(the exclude list above means that the link will not appear (again) under the "Sentry for JavaScript" heading)

bruno-garcia · 2022-12-06T01:19:17Z

src/docs/product/session-replay/getting-started.mdx

+sidebar_order: 1
+redirect_from:
+  - /session-replay/setup/
+  - /session-replay/getting-started/


To replace:

sentry-docs/src/platforms/javascript/common/configuration/integrations/rrweb.mdx

Line 6 in 7197fd3

- /platforms/javascript/integrations/rrweb/

Would require removing this page from the docs on this PR:

sentry-docs/src/platforms/javascript/common/configuration/integrations/rrweb.mdx

Line 6 in 7197fd3

- /platforms/javascript/integrations/rrweb/

/platforms/javascript/configuration/integrations/rrweb/ being the current path
and /platforms/javascript/integrations/rrweb/ the old one

Suggested change

- /session-replay/getting-started/

- /session-replay/getting-started/

- /platforms/javascript/integrations/rrweb/

- /platforms/javascript/configuration/integrations/rrweb/

bruno-garcia · 2022-12-06T01:20:17Z

src/docs/product/session-replay/getting-started.mdx

+---
+title: Set Up
+sidebar_order: 1
+redirect_from:
+  - /session-replay/setup/
+  - /session-replay/getting-started/
+description: "Get started with Session Replay, TODO."
+---


I imagine Set Up is mainly a client-side/SDK thing? If so, we could probably get by without the sub page to start? Basically add all content on the landing Session Replay page for now

src/platforms/common/session-replay/index.mdx

Lms24

LGTM so far, thanks for writing all of this up!

Lms24 · 2022-12-06T07:30:29Z

src/platform-includes/session-replay/enable-session-replay/javascript.mdx

+  <!--
+    Note that `bundle.replay.min.js` contains both `@sentry/browser` AND
+    `@sentry/replay`, and should therefore be used in place of
+    `@sentry/browser`'s bundle rather than in addition to it.
+  -->


This bundle doesn't exist and the bundle that's going to be released is an addon bundle, containing only the replay integration. So to install the SDK plus Replay, users have to add the follwing bundles:

bundle(.tracing)?(.min)?.js

replay(.min)?.js

So, the setup is identical to how to use our other pluggable integrations.

I was going to add instructions to the README today. I can also update this example if you want.

Update - Here are the readme docs for the CDN bundle: https://github.com/getsentry/sentry-javascript/blob/master/packages/replay/README.md#loading-replay-as-a-cdn-bundle

Lms24 · 2022-12-06T07:34:37Z

src/docs/product/session-replay/getting-started.mdx

+
+## Supported SDKs
+
+- JavaScript


We should add the plain Browser SDK (@sentry/browser) here for users who don't rely on a framework

Lms24 · 2022-12-06T07:39:44Z

src/platform-includes/session-replay/configure-sample-rate/javascript.mdx

+
+  // This enables automatic instrumentation (highly recommended), but is not
+  // necessary for purely manual usage
+  integrations: [new Replay()],


We'll also need to add a CDN tab here, as the setup isn't 100% identical (the namespace for the integration is Sentry.Integrations.Replay). As already said above, I can add this later if you want.

Lms24 · 2022-12-06T07:43:26Z

src/platforms/common/session-replay/index.mdx

+
+With [session replay](/product/session-replay/), TODO.
+
+<PlatformSection supported={["javascript", "javascript.vue", "java.spring", "react-native"]} notSupported={["java", "go", "android", "ruby", "python", "dotnet", "dart", "native"]}>


You have way more context here but just out of curioisity, java.spring really supports Replay? Are they using the Browser SDK?

Also, do we need to explicilty add javascript.vue or is it automatically included by javascript?

ah, this is all copy+paste that i missed. none of these are really supported

Lms24 · 2022-12-06T07:48:55Z

src/platforms/common/session-replay/index.mdx

+## Enable Session Replay
+
+<PlatformContent includePath="session-replay/enable-session-replay" />
+
+</PlatformSection>
+
+## Configure the Sample Rate


I think we should change the order here a little in the sense that it's most important for users to understand how to set up Replay. So under "Enable Session Replay" I think we should already show both code examples (installing the package and the Sentry.init call).

Below then, we can describe the impact of the sample rates and (maybe later on) the other configuration options.

Side note (no relevant for this PR): I just saw that our docs for Performance setup have the same structure so we might wanna refactor it a bit there as well.

Lms24 · 2022-12-06T07:50:40Z

src/platforms/common/session-replay/index.mdx

+While you're testing, set <PlatformIdentifier name="replays-session-sample-rate" /> to `1.0`, as that ensures that every user session will be sent to Sentry.
+
+Once testing is complete, **we recommend lowering this value in production** by either lowering your <PlatformIdentifier name="replays-session-sample-rate" /> value. We still recommend keeping <PlatformIdentifier name="replays-on-error-sample-rate" /> set to `1.0`.
+


Should we add another subsection here (e.g. ## Advanced Configuration or something similar) and link to the Readme for the time being? This way, users can be made aware that there are additional configuration options.

I followed @jas-kas 's plan and created pages/sections based on #5903

basically copy+pasted all the things from the README in the sdk repo

Lms24 · 2022-12-06T07:57:59Z

src/platform-includes/session-replay/configure-sample-rate/javascript.mdx

+  // This enables automatic instrumentation (highly recommended), but is not
+  // necessary for purely manual usage


Suggested change

// This enables automatic instrumentation (highly recommended), but is not

// necessary for purely manual usage

I would honestly just delete this to keep it as simple as possible for the majority of our users here. (see my comment about "Advanced Configuration", as we're describing more manual usage in the Readme).

ryan953 · 2022-12-07T00:50:48Z

src/platforms/common/session-replay/custom-instrumentation/privacy-configuration.mdx

+### Ignoring
+Ignoring only applies to form inputs. Events will be ignored on the input element so that the replay does not show what occurs inside of the input. In the below example, notice how the results in the table below the input changes, but no text is visible in the input.
+
+![Ignoring Example](session-replay-ignore-input.mp4)


This isn't playing, it was originally a .mov file, i renamed it because some googling suggested that... it didn't work

Next approach: convert it to gif

Lms24

Looks good to me! Thanks for addressing my previous feedback. I just have two more comments but nothing blocking.

src/platform-includes/session-replay/install-session-replay/javascript.mdx

src/platform-includes/session-replay/setup-session-replay/javascript.mdx

Lms24 · 2022-12-07T10:25:29Z

src/platforms/javascript/common/session-replay/custom-instrumentation/index.mdx

@@ -0,0 +1,24 @@
+---
+title: Custom Instrumentation


nit (feel free to ignore): Is "Custom Instrumentation" the correct title here? To me, the content here seems to be more around additional advanced configuration than doing custom things (maybe apart from the manual Replay start/stop section). No strong opinion here, though. We can also revisit this later.

I don't have a strong opinion on this either, just copy+pasting from #5903 and learning how the docs site works.

Lets revisit it as part of #5913, there's already a suggested change in there.

Craft uses the release artifacts zip generated by our "Upload Artifacts" job to search for files to upload. Our bundle path (`packages/replay/build/bundles`) wasn't added to this job's config so it wasn't included in the release. This patch fixes that and it also adds an entry to our release checklist. It furthermore bumps the minimum version for the CDN bundles in the Replay README. Docs should automatically pick up the newest version, so we don't need to bump anything in getsentry/sentry-docs#5899 Co-authored-by: Abhijeet Prasad <[email protected]>

…script.mdx Co-authored-by: Lukas Stracke <[email protected]>

…vascript.mdx Co-authored-by: Lukas Stracke <[email protected]>

…2126) Depends on getsentry/sentry-docs#5899

WIP - skeleton of all the files we need for Session Replay docs

89e556d

ryan953 requested review from mydea, Lms24 and a team December 6, 2022 00:55

ryan953 marked this pull request as draft December 6, 2022 00:55

ryan953 commented Dec 6, 2022

View reviewed changes

vercel bot deployed to Preview December 6, 2022 01:13 View deployment

bruno-garcia reviewed Dec 6, 2022

View reviewed changes

Lms24 reviewed Dec 6, 2022

View reviewed changes

jas-kas linked an issue Dec 6, 2022 that may be closed by this pull request

Session Replay - SDK Documentation on the docs site #5903

Closed

18 tasks

Do performance examples separatly

c2b1d9c

ryan953 force-pushed the ryan953/replay-docs-skeleton branch from 5238924 to c2b1d9c Compare December 6, 2022 16:35

vercel bot deployed to Preview December 6, 2022 17:09 View deployment

ryan953 added 2 commits December 6, 2022 14:23

remove change to src/pages/index.tsx

553cc9b

Remove product docs skeleton, it is inside #5912

31cad28

ryan953 changed the title ~~WIP - skeleton of all the files we need for Session Replay docs~~ WIP - SDK docs skeleton Dec 6, 2022

vercel bot deployed to Preview December 6, 2022 22:55 View deployment

Update all the pages according to #5903

52fe3bc

ryan953 marked this pull request as ready for review December 7, 2022 00:49

ryan953 commented Dec 7, 2022

View reviewed changes

put everything under src/platforms/javascript/common

c5de429

ryan953 changed the title ~~WIP - SDK docs skeleton~~ Initial Session Replay SDK Docs Dec 7, 2022

vercel bot deployed to Preview December 7, 2022 01:20 View deployment

ryan953 added 4 commits December 6, 2022 19:30

convert the mov to a gif

ad028d2

fix image paths

af01e2d

add beta note and consistent supported/notSupported front matter

b9d23c3

make the "beta notice" a shared file

70024a1

ryan953 mentioned this pull request Dec 7, 2022

feat(replays): Update onboarding links to point to docs.sentry.io getsentry/sentry#42126

Merged

ryan953 mentioned this pull request Dec 7, 2022

Update Replay Wizard links and examples to link to docs and use correct field names #5914

Merged

vercel bot deployed to Preview December 7, 2022 04:18 View deployment

ryan953 requested review from bruno-garcia, Lms24 and jas-kas December 7, 2022 04:28

Lms24 approved these changes Dec 7, 2022

View reviewed changes

Lms24 mentioned this pull request Dec 7, 2022

fix(replay): Add CDN bundle path to release artifacts getsentry/sentry-javascript#6452

Merged

Lms24 mentioned this pull request Dec 7, 2022

replay: alternative structure #5913

Closed

ryan953 and others added 3 commits December 7, 2022 08:52

Update src/platform-includes/session-replay/setup-session-replay/java…

d6aea22

…script.mdx Co-authored-by: Lukas Stracke <[email protected]>

Update src/platform-includes/session-replay/install-session-replay/ja…

e6464ad

…vascript.mdx Co-authored-by: Lukas Stracke <[email protected]>

Merge branch 'master' into ryan953/replay-docs-skeleton

c384c3f

ryan953 merged commit bd7347a into master Dec 7, 2022

ryan953 deleted the ryan953/replay-docs-skeleton branch December 7, 2022 17:20

ryan953 added a commit to getsentry/sentry that referenced this pull request Dec 7, 2022

feat(replays): Update onboarding links to point to docs.sentry.io (#4…

577275f

…2126) Depends on getsentry/sentry-docs#5899

vercel bot deployed to Preview December 7, 2022 17:46 View deployment

github-actions bot locked and limited conversation to collaborators Dec 23, 2022


		With [session replay](/product/session-replay/), TODO.

		<PlatformSection supported={["javascript", "javascript.vue", "java.spring", "react-native"]} notSupported={["java", "go", "android", "ruby", "python", "dotnet", "dart", "native"]}>

		While you're testing, set <PlatformIdentifier name="replays-session-sample-rate" /> to `1.0`, as that ensures that every user session will be sent to Sentry.

		Once testing is complete, we recommend lowering this value in production by either lowering your <PlatformIdentifier name="replays-session-sample-rate" /> value. We still recommend keeping <PlatformIdentifier name="replays-on-error-sample-rate" /> set to `1.0`.

		// This enables automatic instrumentation (highly recommended), but is not
		// necessary for purely manual usage

Uh oh!

Initial Session Replay SDK Docs #5899

Initial Session Replay SDK Docs #5899

Uh oh!

Conversation

ryan953 commented Dec 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Dec 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ryan953 Dec 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ryan953 Dec 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Lms24 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Lms24 Dec 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Lms24 Dec 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Lms24 Dec 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Lms24 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ryan953 commented Dec 6, 2022 •

edited

Loading

vercel bot commented Dec 6, 2022 •

edited

Loading

ryan953 Dec 6, 2022 •

edited

Loading

ryan953 Dec 6, 2022 •

edited

Loading

Lms24 Dec 6, 2022 •

edited

Loading

Lms24 Dec 6, 2022 •

edited

Loading

Lms24 Dec 6, 2022 •

edited

Loading