Skip to content

replay: alternative structure#5913

Closed
bruno-garcia wants to merge 7 commits intomasterfrom
ref/session-replay-structure-suggestion
Closed

replay: alternative structure#5913
bruno-garcia wants to merge 7 commits intomasterfrom
ref/session-replay-structure-suggestion

Conversation

@bruno-garcia
Copy link
Copy Markdown
Member

Alternative structure. Comments inline

@vercel
Copy link
Copy Markdown

vercel bot commented Dec 7, 2022

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 2:42AM (UTC)

replay.stop(); // Stop recording
```

## General Integration Configuration
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Starting with the sampling options, which are the main ones/everyone will use

| inlineStylesheet | boolean | `true` | Should inline stylesheets used in the recording |
| recordCanvas | boolean | `false` | Should record `<canvas>` elements |

## Identifying Users
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Identifying user is an SDK specific thing. It'll improve the user experience for sure, so makes total sense to add here. I tried to word it a bit as "here are the actual docs, but here's a quick snippet to get you started"

});
```

## Start and Stop Recording Manually
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm assuming here we prefer users keep with defaults and let the SDK start/stop. Is that valid? For that reason, moving to the bottom.

These APIs can become a source of support issues, where the SDK is already start/stopping but users decide to call it too and then are confused by the duration of replays. For that reason, if debug=true and start() is called but there's already a replay running, worth logging out, for discoverability sake.

Do we know of some use cases when users want to start/stop manually? Is it worth adding here to the docs "you for example want to xyz"?

@bruno-garcia bruno-garcia changed the title alternative structure replay: alternative structure Dec 7, 2022
Copy link
Copy Markdown
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this flatter structure of the docs. It also addresses a concern I had about the "Custom Instrumentation" section.

Comment on lines -1 to -7
---
title: Custom Instrumentation
sidebar_order: 4100
description: "Learn how to set up General and Privacy aware configuration fields."
---

<PageGrid />
Copy link
Copy Markdown
Member

@ryan953 ryan953 Dec 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whatever the name is, it's nice to have a single url to capture both sets of configs (and i agree that it's nice to split out privacy configs and give them their own headers)

I had intended to link directly to this page from our in-app onboarding wizard: #5914. So for that reason I think we should keep this page, name changes are fine with me.

Base automatically changed from ryan953/replay-docs-skeleton to master December 7, 2022 17:20
@bruno-garcia
Copy link
Copy Markdown
Member Author

Thanks @imatwawana 🙏 will take this changes in a follow up PR (target was merged into master)


<script
src="https://browser.sentry-cdn.com/{{ packages.version('sentry.javascript.browser') }}/bundle.min.js"
integrity="sha384-{{ packages.checksum('sentry.javascript.browser', 'bundle.min.js', 'sha384-base64') }}"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

drive by review: we should make this the browser + performance bundle so it's easy for folks to use performance monitoring if they want to in the future.

@bruno-garcia
Copy link
Copy Markdown
Member Author

Superseded by #5927

@bruno-garcia bruno-garcia deleted the ref/session-replay-structure-suggestion branch December 8, 2022 18:10
@github-actions github-actions bot locked and limited conversation to collaborators Dec 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants