From 60c6aa7dfb229a18a4f906dfcd3120d427f23acc Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Mon, 16 Jan 2023 16:06:58 +0100 Subject: [PATCH] feat(replay): Update replay setup docs --- .../javascript/common/session-replay/index.mdx | 6 ++---- .../javascript/replay-onboarding/angular/1.install.md | 10 +--------- .../javascript/replay-onboarding/ember/1.install.md | 6 +----- .../javascript/replay-onboarding/ember/2.configure.md | 1 - .../javascript/replay-onboarding/gatsby/1.install.md | 10 +--------- .../replay-onboarding/javascript/1.install.md | 2 +- .../javascript/replay-onboarding/nextjs/1.install.md | 10 +--------- .../javascript/replay-onboarding/nextjs/2.configure.md | 2 +- .../javascript/replay-onboarding/react/1.install.md | 10 +--------- .../javascript/replay-onboarding/remix/1.install.md | 10 +--------- .../javascript/replay-onboarding/remix/2.configure.md | 2 +- .../javascript/replay-onboarding/svelte/1.install.md | 10 +--------- .../javascript/replay-onboarding/vue/1.install.md | 10 +--------- .../javascript/replay-onboarding/vue/2.configure.md | 3 +-- 14 files changed, 14 insertions(+), 78 deletions(-) diff --git a/src/platforms/javascript/common/session-replay/index.mdx b/src/platforms/javascript/common/session-replay/index.mdx index 55c73a07611a1..2c7000b67346f 100644 --- a/src/platforms/javascript/common/session-replay/index.mdx +++ b/src/platforms/javascript/common/session-replay/index.mdx @@ -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 diff --git a/src/wizard/javascript/replay-onboarding/angular/1.install.md b/src/wizard/javascript/replay-onboarding/angular/1.install.md index 124081bb677a8..78b66f5d9a3ec 100644 --- a/src/wizard/javascript/replay-onboarding/angular/1.install.md +++ b/src/wizard/javascript/replay-onboarding/angular/1.install.md @@ -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. \ No newline at end of file diff --git a/src/wizard/javascript/replay-onboarding/ember/1.install.md b/src/wizard/javascript/replay-onboarding/ember/1.install.md index a1db2f0f8f39a..6ffa1839f0ade 100644 --- a/src/wizard/javascript/replay-onboarding/ember/1.install.md +++ b/src/wizard/javascript/replay-onboarding/ember/1.install.md @@ -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. \ No newline at end of file diff --git a/src/wizard/javascript/replay-onboarding/ember/2.configure.md b/src/wizard/javascript/replay-onboarding/ember/2.configure.md index a4a629c10452b..eed72bf0e7a5d 100644 --- a/src/wizard/javascript/replay-onboarding/ember/2.configure.md +++ b/src/wizard/javascript/replay-onboarding/ember/2.configure.md @@ -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___", diff --git a/src/wizard/javascript/replay-onboarding/gatsby/1.install.md b/src/wizard/javascript/replay-onboarding/gatsby/1.install.md index f6cf0d517b8b0..4aa9b6375cca2 100644 --- a/src/wizard/javascript/replay-onboarding/gatsby/1.install.md +++ b/src/wizard/javascript/replay-onboarding/gatsby/1.install.md @@ -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. \ No newline at end of file diff --git a/src/wizard/javascript/replay-onboarding/javascript/1.install.md b/src/wizard/javascript/replay-onboarding/javascript/1.install.md index 13f35bb8b5e7a..caed4f2ff3f01 100644 --- a/src/wizard/javascript/replay-onboarding/javascript/1.install.md +++ b/src/wizard/javascript/replay-onboarding/javascript/1.install.md @@ -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 diff --git a/src/wizard/javascript/replay-onboarding/nextjs/1.install.md b/src/wizard/javascript/replay-onboarding/nextjs/1.install.md index 5915d0c841fb3..119cf4bb6f87f 100644 --- a/src/wizard/javascript/replay-onboarding/nextjs/1.install.md +++ b/src/wizard/javascript/replay-onboarding/nextjs/1.install.md @@ -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. \ No newline at end of file diff --git a/src/wizard/javascript/replay-onboarding/nextjs/2.configure.md b/src/wizard/javascript/replay-onboarding/nextjs/2.configure.md index 4e6f2cf197432..32bcd9edf3bfb 100644 --- a/src/wizard/javascript/replay-onboarding/nextjs/2.configure.md +++ b/src/wizard/javascript/replay-onboarding/nextjs/2.configure.md @@ -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`. diff --git a/src/wizard/javascript/replay-onboarding/react/1.install.md b/src/wizard/javascript/replay-onboarding/react/1.install.md index 42a89474b886f..17f1a0d10fee3 100644 --- a/src/wizard/javascript/replay-onboarding/react/1.install.md +++ b/src/wizard/javascript/replay-onboarding/react/1.install.md @@ -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. \ No newline at end of file diff --git a/src/wizard/javascript/replay-onboarding/remix/1.install.md b/src/wizard/javascript/replay-onboarding/remix/1.install.md index a937fda16c48b..58d32507e3ff7 100644 --- a/src/wizard/javascript/replay-onboarding/remix/1.install.md +++ b/src/wizard/javascript/replay-onboarding/remix/1.install.md @@ -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. \ No newline at end of file diff --git a/src/wizard/javascript/replay-onboarding/remix/2.configure.md b/src/wizard/javascript/replay-onboarding/remix/2.configure.md index e82cbfaefc1fc..2ea98eecca257 100644 --- a/src/wizard/javascript/replay-onboarding/remix/2.configure.md +++ b/src/wizard/javascript/replay-onboarding/remix/2.configure.md @@ -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`. diff --git a/src/wizard/javascript/replay-onboarding/svelte/1.install.md b/src/wizard/javascript/replay-onboarding/svelte/1.install.md index 01b96ea27a280..635b9bd883c24 100644 --- a/src/wizard/javascript/replay-onboarding/svelte/1.install.md +++ b/src/wizard/javascript/replay-onboarding/svelte/1.install.md @@ -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. \ No newline at end of file diff --git a/src/wizard/javascript/replay-onboarding/vue/1.install.md b/src/wizard/javascript/replay-onboarding/vue/1.install.md index 3de9fa55e5ada..22147f09f4f08 100644 --- a/src/wizard/javascript/replay-onboarding/vue/1.install.md +++ b/src/wizard/javascript/replay-onboarding/vue/1.install.md @@ -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. \ No newline at end of file diff --git a/src/wizard/javascript/replay-onboarding/vue/2.configure.md b/src/wizard/javascript/replay-onboarding/vue/2.configure.md index 0718acbef1abc..4966990fac98c 100644 --- a/src/wizard/javascript/replay-onboarding/vue/2.configure.md +++ b/src/wizard/javascript/replay-onboarding/vue/2.configure.md @@ -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({ // ... @@ -70,7 +69,7 @@ Sentry.init({ // sessions when an error occurs. replaysOnErrorSampleRate: 1.0, - integrations: [new Replay()], + integrations: [new Sentry.Replay()], }); app.use(router);