Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

replay: onboarding specific per sdk #7883

Merged
merged 6 commits into from
Sep 23, 2023
Merged

replay: onboarding specific per sdk #7883

merged 6 commits into from
Sep 23, 2023

Conversation

bruno-garcia
Copy link
Member

Resolves: #7045

@bruno-garcia bruno-garcia requested review from a team as code owners September 19, 2023 21:46
@vercel
Copy link

vercel bot commented Sep 19, 2023

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

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 23, 2023 8:06pm

@bruno-garcia bruno-garcia changed the title replay commit replay: onboarding specific per sdk Sep 19, 2023
Comment on lines +3 to 9
```bash {tabTitle:Angular}
# npm
npm install --save @sentry/capacitor @sentry/angular-ivy @sentry/replay

# yarn
yarn add @sentry/capacitor @sentry/angular-ivy @sentry/replay
```
Copy link
Member

Choose a reason for hiding this comment

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

does the user need to install @sentry/replay if they're already doing @sentry/angular-ivy or @sentry/vue or whatever the framework is?

Copy link
Member Author

Choose a reason for hiding this comment

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

Comment on lines +11 to 17
```bash {tabTitle:Other Frameworks}
# npm
npm install --save @sentry/capacitor @sentry/replay

# yarn
yarn add @sentry/capacitor @sentry/replay
```
Copy link
Member

Choose a reason for hiding this comment

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

similar to above, should this be @sentry/capacitor @sentry/javascript?

Copy link
Member Author

Choose a reason for hiding this comment

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

capacitor isn't part of the monorepo so I'm not sure if the re-export done works, but possibly so. I'll check and update on a follow up PR

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

this file is copy+pasted a few times (9 times). I didn't notice any errors with that, but idk if we can or should de-dupe it to make maintenance easier.

note that nextjs and remix and sveltekit have little headers at the top of the files which are nice to keep: "On your client-side NextJS app, add:"

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmmm yeah there is some duplication. We could pull both code snippets out into their own components, but I'm not sure it's worth the extra complexity here.

src/platforms/javascript/common/session-replay/index.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmmm yeah there is some duplication. We could pull both code snippets out into their own components, but I'm not sure it's worth the extra complexity here.

Comment on lines +11 to +12
// If the entire session is not sampled, use the below sample rate to sample
// sessions when an error occurs.
Copy link
Contributor

Choose a reason for hiding this comment

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

I know this is just copied from existing docs, but this comment is confusing. This makes it sound like if you're setting replaysSessionSampleRate to 1.0 you can downsample errors with replaysSessionSampleRate, which is the opposite of the usual use case, right?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sorry i don't see how this phrase makes it sound like it's 1.0 (also the actual value is right above it so unlikely confusing)?

That said: happy to change these comments to something that makes more sense. Due to all the copy paste we'd need a find/replace. Best as a follow up PR

Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>
@bruno-garcia bruno-garcia enabled auto-merge (squash) September 23, 2023 20:00
@bruno-garcia bruno-garcia merged commit b2d8bd4 into master Sep 23, 2023
6 of 7 checks passed
@bruno-garcia bruno-garcia deleted the replay/install branch September 23, 2023 20:05
@github-actions github-actions bot locked and limited conversation to collaborators Oct 9, 2023
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.

Session Replay Set Up: Code snippet specific to integration
3 participants