From 3aa889c6856f9ac54402cafe1a8f7960189fc650 Mon Sep 17 00:00:00 2001 From: Tim Fish Date: Thu, 23 Mar 2023 12:54:54 +0000 Subject: [PATCH 1/3] remove `@sentry/tracing` from readmes --- packages/angular-ivy/README.md | 10 ++++------ packages/angular/README.md | 11 +++++------ packages/gatsby/README.md | 2 +- packages/react/README.md | 2 +- packages/svelte/README.md | 3 +-- 5 files changed, 12 insertions(+), 16 deletions(-) diff --git a/packages/angular-ivy/README.md b/packages/angular-ivy/README.md index c96f89420559..655198016893 100644 --- a/packages/angular-ivy/README.md +++ b/packages/angular-ivy/README.md @@ -80,8 +80,7 @@ see `ErrorHandlerOptions` interface in `src/errorhandler.ts`. ### Tracing -`@sentry/angular-ivy` exports a Trace Service, Directive and Decorators that leverage the `@sentry/tracing` Tracing -integration to add Angular related spans to transactions. If the Tracing integration is not enabled, this functionality +`@sentry/angular-ivy` exports a Trace Service, Directive and Decorators that leverage the tracing features to add Angular related spans to transactions. If the tracing features are not enabled, this functionality will not work. The service itself tracks route changes and durations, where directive and decorators are tracking components initializations. @@ -89,17 +88,16 @@ components initializations. Registering a Trace Service is a 3-step process. -1. Register and configure the `BrowserTracing` integration from `@sentry/tracing`, including custom Angular routing +1. Register and configure the `BrowserTracing` integration, including custom Angular routing instrumentation: ```javascript -import { init, instrumentAngularRouting } from '@sentry/angular-ivy'; -import { Integrations as TracingIntegrations } from '@sentry/tracing'; +import { init, instrumentAngularRouting, BrowserTracing } from '@sentry/angular-ivy'; init({ dsn: '__DSN__', integrations: [ - new TracingIntegrations.BrowserTracing({ + new BrowserTracing({ tracingOrigins: ['localhost', 'https://yourserver.io/api'], routingInstrumentation: instrumentAngularRouting, }), diff --git a/packages/angular/README.md b/packages/angular/README.md index b03b24195fb0..4bc6f3738d75 100644 --- a/packages/angular/README.md +++ b/packages/angular/README.md @@ -76,8 +76,8 @@ see `ErrorHandlerOptions` interface in `src/errorhandler.ts`. ### Tracing -`@sentry/angular` exports a Trace Service, Directive and Decorators that leverage the `@sentry/tracing` Tracing -integration to add Angular related spans to transactions. If the Tracing integration is not enabled, this functionality +`@sentry/angular` exports a Trace Service, Directive and Decorators that leverage the tracing +features to add Angular related spans to transactions. If the tracing features are not enabled, this functionality will not work. The service itself tracks route changes and durations, where directive and decorators are tracking components initializations. @@ -85,17 +85,16 @@ components initializations. Registering a Trace Service is a 3-step process. -1. Register and configure the `BrowserTracing` integration from `@sentry/tracing`, including custom Angular routing +1. Register and configure the `BrowserTracing` integration, including custom Angular routing instrumentation: ```javascript -import { init, instrumentAngularRouting } from '@sentry/angular'; -import { Integrations as TracingIntegrations } from '@sentry/tracing'; +import { init, instrumentAngularRouting, BrowserTracing } from '@sentry/angular'; init({ dsn: '__DSN__', integrations: [ - new TracingIntegrations.BrowserTracing({ + new BrowserTracing({ tracingOrigins: ['localhost', 'https://yourserver.io/api'], routingInstrumentation: instrumentAngularRouting, }), diff --git a/packages/gatsby/README.md b/packages/gatsby/README.md index 22e181c5c70f..c20f3355e297 100644 --- a/packages/gatsby/README.md +++ b/packages/gatsby/README.md @@ -39,7 +39,7 @@ To automatically capture the `release` value on Vercel you will need to register ## Sentry Performance -To enable tracing, supply either `tracesSampleRate` or `tracesSampler` to the options and make sure you have installed the `@sentry/tracing` package. This will also turn on the `BrowserTracing` integration for automatic instrumentation of pageloads and navigations. +To enable tracing, supply either `tracesSampleRate` or `tracesSampler` to the options. This will turn on the `BrowserTracing` integration for automatic instrumentation of pageloads and navigations. ```javascript module.exports = { diff --git a/packages/react/README.md b/packages/react/README.md index 761083801ca1..7ddcabc011eb 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -67,7 +67,7 @@ export default App; ### Profiler -`@sentry/react` exports a Profiler component that leverages the `@sentry/tracing` Tracing integration to add React related +`@sentry/react` exports a Profiler component that leverages the tracing features to add React related spans to transactions. If the Tracing integration is not enabled, the Profiler component will not work. The Profiler tracks component mount, render duration and updates. Requires React version >= 15. diff --git a/packages/svelte/README.md b/packages/svelte/README.md index c19ab728a2bf..4fb87a431787 100644 --- a/packages/svelte/README.md +++ b/packages/svelte/README.md @@ -25,13 +25,12 @@ To use the SDK, initialize Sentry in your Svelte entry point `main.js` before yo import App from "./App.svelte"; import * as Sentry from "@sentry/svelte"; -import { BrowserTracing } from "@sentry/tracing"; // Initialize the Sentry SDK here Sentry.init({ dsn: "__DSN__", release: "my-project-name@2.3.12", - integrations: [new BrowserTracing()], + integrations: [new Sentry.BrowserTracing()], // Set tracesSampleRate to 1.0 to capture 100% // of transactions for performance monitoring. From e82641d2919b2223df3133bf8cc324f9c042419d Mon Sep 17 00:00:00 2001 From: Tim Fish Date: Thu, 23 Mar 2023 17:50:41 +0000 Subject: [PATCH 2/3] Better wording --- packages/angular-ivy/README.md | 5 +++-- packages/angular/README.md | 2 +- packages/react/README.md | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/packages/angular-ivy/README.md b/packages/angular-ivy/README.md index 655198016893..249983cc270e 100644 --- a/packages/angular-ivy/README.md +++ b/packages/angular-ivy/README.md @@ -80,8 +80,9 @@ see `ErrorHandlerOptions` interface in `src/errorhandler.ts`. ### Tracing -`@sentry/angular-ivy` exports a Trace Service, Directive and Decorators that leverage the tracing features to add Angular related spans to transactions. If the tracing features are not enabled, this functionality -will not work. The service itself tracks route changes and durations, where directive and decorators are tracking +`@sentry/angular-ivy` exports a Trace Service, Directive and Decorators that leverage the tracing features to add +Angular related spans to transactions. If tracing is not enabled, this functionality will not work. The service itself +tracks route changes and durations, where directive and decorators are tracking components initializations. #### Install diff --git a/packages/angular/README.md b/packages/angular/README.md index 4bc6f3738d75..f6ae98ed6475 100644 --- a/packages/angular/README.md +++ b/packages/angular/README.md @@ -77,7 +77,7 @@ see `ErrorHandlerOptions` interface in `src/errorhandler.ts`. ### Tracing `@sentry/angular` exports a Trace Service, Directive and Decorators that leverage the tracing -features to add Angular related spans to transactions. If the tracing features are not enabled, this functionality +features to add Angular related spans to transactions. If tracing is not enabled, this functionality will not work. The service itself tracks route changes and durations, where directive and decorators are tracking components initializations. diff --git a/packages/react/README.md b/packages/react/README.md index 7ddcabc011eb..25566b2e9ff2 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -68,7 +68,7 @@ export default App; ### Profiler `@sentry/react` exports a Profiler component that leverages the tracing features to add React related -spans to transactions. If the Tracing integration is not enabled, the Profiler component will not work. The Profiler +spans to transactions. If tracing is not enabled, the Profiler component will not work. The Profiler tracks component mount, render duration and updates. Requires React version >= 15. > app.js From 4ddedd1be9181dcc2b4d26944c9904d576a954fd Mon Sep 17 00:00:00 2001 From: Tim Fish Date: Fri, 24 Mar 2023 09:31:13 +0000 Subject: [PATCH 3/3] Code review changes --- packages/angular-ivy/README.md | 6 +++--- packages/angular/README.md | 4 ++-- packages/react/README.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/angular-ivy/README.md b/packages/angular-ivy/README.md index 249983cc270e..b1d19b0a7edf 100644 --- a/packages/angular-ivy/README.md +++ b/packages/angular-ivy/README.md @@ -81,9 +81,9 @@ see `ErrorHandlerOptions` interface in `src/errorhandler.ts`. ### Tracing `@sentry/angular-ivy` exports a Trace Service, Directive and Decorators that leverage the tracing features to add -Angular related spans to transactions. If tracing is not enabled, this functionality will not work. The service itself -tracks route changes and durations, where directive and decorators are tracking -components initializations. +Angular-related spans to transactions. If tracing is not enabled, this functionality will not work. The SDK's +`TraceService` itself tracks route changes and durations, while directive and decorators are tracking components +initializations. #### Install diff --git a/packages/angular/README.md b/packages/angular/README.md index f6ae98ed6475..9f95ac87bf01 100644 --- a/packages/angular/README.md +++ b/packages/angular/README.md @@ -77,8 +77,8 @@ see `ErrorHandlerOptions` interface in `src/errorhandler.ts`. ### Tracing `@sentry/angular` exports a Trace Service, Directive and Decorators that leverage the tracing -features to add Angular related spans to transactions. If tracing is not enabled, this functionality -will not work. The service itself tracks route changes and durations, where directive and decorators are tracking +features to add Angular-related spans to transactions. If tracing is not enabled, this functionality +will not work. The SDK's `TraceService` itself tracks route changes and durations, while directive and decorators are tracking components initializations. #### Install diff --git a/packages/react/README.md b/packages/react/README.md index 25566b2e9ff2..bddbfc6845f5 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -67,7 +67,7 @@ export default App; ### Profiler -`@sentry/react` exports a Profiler component that leverages the tracing features to add React related +`@sentry/react` exports a Profiler component that leverages the tracing features to add React-related spans to transactions. If tracing is not enabled, the Profiler component will not work. The Profiler tracks component mount, render duration and updates. Requires React version >= 15.