Skip to content

feat(replay): Update replay setup docs #6082

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 17, 2023
Merged

feat(replay): Update replay setup docs #6082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions src/platforms/javascript/common/session-replay/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,9 @@ By default, it'll mask all fields, so no personally identifiable information (PI

## Pre-requisites

For the sentry-replay integration to work, you must have the [Sentry browser SDK package](https://www.npmjs.com/package/@sentry/browser), or an equivalent framework SDK (for example, [@sentry/react](https://www.npmjs.com/package/@sentry/react)) installed. The minimum version required for the SDK is `7.24.0`.
For the sentry-replay integration to work, you must have the [Sentry browser SDK package](https://www.npmjs.com/package/@sentry/browser), or an equivalent framework SDK (for example, [@sentry/react](https://www.npmjs.com/package/@sentry/react)) installed. The minimum version required for the SDK is `7.27.0`.

Make sure to use the exact same version of `@sentry/replay` as your other Sentry package(s), such as `@sentry/browser` or `@sentry/react`.

`@sentry/replay` requires Node 12+, and browsers newer than IE11.
Session Replay requires Node 12+, and browsers newer than IE11.

## Install

Expand Down
10 changes: 1 addition & 9 deletions src/wizard/javascript/replay-onboarding/angular/1.install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,4 @@ type: language

#### Install

For the `@sentry/replay` integration to work, you must have the Sentry browser SDK package, or an equivalent framework SDK (e.g. @sentry/react) installed, minimum version 7.x.

```bash
# Using yarn
yarn add @sentry/angular

# Using npm
npm install --save @sentry/angular
```
You need a minimum version 7.27.0 of `@sentry/angular` in order to use Session Replay. You don't need to install any additional packages.
6 changes: 1 addition & 5 deletions src/wizard/javascript/replay-onboarding/ember/1.install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,4 @@ type: language

#### Install

For the `@sentry/replay` integration to work, you must have the Sentry browser SDK package, or an equivalent framework SDK (e.g. @sentry/react) installed, minimum version 7.x.

```bash {tabTitle:ember-cli}
ember install @sentry/ember
```
You need a minimum version 7.27.0 of `@sentry/ember` in order to use Session Replay. You don't need to install any additional packages.
1 change: 0 additions & 1 deletion src/wizard/javascript/replay-onboarding/ember/2.configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Add the following to your SDK config. There are several privacy and sampling opt

```javascript
import * as Sentry from "@sentry/ember";
import { Replay } from "@sentry/replay";

Sentry.init({
dsn: "___PUBLIC_DSN___",
Expand Down
10 changes: 1 addition & 9 deletions src/wizard/javascript/replay-onboarding/gatsby/1.install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,4 @@ type: language

#### Install

For the `@sentry/replay` integration to work, you must have the Sentry browser SDK package, or an equivalent framework SDK (e.g. @sentry/react) installed, minimum version 7.x.

```bash
# Using yarn
yarn add @sentry/gatsby

# Using npm
npm install --save @sentry/gatsby
```
You need a minimum version 7.27.0 of `@sentry/gatsby` in order to use Session Replay. You don't need to install any additional packages.
2 changes: 1 addition & 1 deletion src/wizard/javascript/replay-onboarding/javascript/1.install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ type: language

#### Install

For the `@sentry/replay` integration to work, you must have the Sentry browser SDK package, or an equivalent framework SDK (e.g. @sentry/react) installed, minimum version 7.x.
For the Session Replay to work, you must have the Sentry browser SDK package, or an equivalent framework SDK (e.g. @sentry/react) installed, minimum version 7.27.0.

```bash
# Using yarn
Expand Down
10 changes: 1 addition & 9 deletions src/wizard/javascript/replay-onboarding/nextjs/1.install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,4 @@ type: language

#### Install

For the `@sentry/replay` integration to work, you must have the Sentry browser SDK package, or an equivalent framework SDK (e.g. @sentry/react) installed, minimum version 7.x.

```bash
# Using yarn
yarn add @sentry/nextjs

# Using npm
npm install --save @sentry/nextjs
```
You need a minimum version 7.27.0 of `@sentry/nextjs` in order to use Session Replay. You don't need to install any additional packages.
2 changes: 1 addition & 1 deletion src/wizard/javascript/replay-onboarding/nextjs/2.configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ Sentry.init({
});
```

Note: The `@sentry/replay` integration only needs to be added to your `sentry.client.config.js` file. It will not run if it is added into `sentry.server.config.js`.
Note: The Replay integration only needs to be added to your `sentry.client.config.js` file. It will not run if it is added into `sentry.server.config.js`.
10 changes: 1 addition & 9 deletions src/wizard/javascript/replay-onboarding/react/1.install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,4 @@ type: language

#### Install

For the `@sentry/replay` integration to work, you must have the Sentry browser SDK package, or an equivalent framework SDK (e.g. @sentry/react) installed, minimum version 7.x.

```bash
# Using yarn
yarn add @sentry/react

# Using npm
npm install --save @sentry/react
```
You need a minimum version 7.27.0 of `@sentry/react` in order to use Session Replay. You don't need to install any additional packages.
10 changes: 1 addition & 9 deletions src/wizard/javascript/replay-onboarding/remix/1.install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,4 @@ type: language

#### Install

For the `@sentry/replay` integration to work, you must have the Sentry browser SDK package, or an equivalent framework SDK (e.g. @sentry/react) installed, minimum version 7.x.

```bash
# Using yarn
yarn add @sentry/remix

# Using npm
npm install --save @sentry/remix
```
You need a minimum version 7.27.0 of `@sentry/remix` in order to use Session Replay. You don't need to install any additional packages.
2 changes: 1 addition & 1 deletion src/wizard/javascript/replay-onboarding/remix/2.configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ Sentry.init({
});
```

Note: The `@sentry/replay` integration only needs to be added to your `entry.client.tsx` file. It will not run if it is added into `sentry.server.config.js`.
Note: The Replay integration only needs to be added to your `entry.client.tsx` file. It will not run if it is added into `sentry.server.config.js`.
10 changes: 1 addition & 9 deletions src/wizard/javascript/replay-onboarding/svelte/1.install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,4 @@ type: language

#### Install

For the `@sentry/replay` integration to work, you must have the Sentry browser SDK package, or an equivalent framework SDK (e.g. @sentry/react) installed, minimum version 7.x.

```bash
# Using yarn
yarn add @sentry/svelte

# Using npm
npm install --save @sentry/svelte
```
You need a minimum version 7.27.0 of `@sentry/svelte` in order to use Session Replay. You don't need to install any additional packages.
10 changes: 1 addition & 9 deletions src/wizard/javascript/replay-onboarding/vue/1.install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,4 @@ type: language

#### Install

For the `@sentry/replay` integration to work, you must have the Sentry browser SDK package, or an equivalent framework SDK (e.g. @sentry/react) installed, minimum version 7.x.

```bash
# Using yarn
yarn add @sentry/vue

# Using npm
npm install --save @sentry/vue
```
You need a minimum version 7.27.0 of `@sentry/vue` in order to use Session Replay. You don't need to install any additional packages.
3 changes: 1 addition & 2 deletions src/wizard/javascript/replay-onboarding/vue/2.configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ new Vue({
import { createApp } from "vue";
import { createRouter } from "vue-router";
import * as Sentry from "@sentry/vue";
import { Replay } from "@sentry/replay";

const app = createApp({
// ...
Expand All @@ -70,7 +69,7 @@ Sentry.init({
// sessions when an error occurs.
replaysOnErrorSampleRate: 1.0,

integrations: [new Replay()],
integrations: [new Sentry.Replay()],
});

app.use(router);
Expand Down