Skip to content

fix(docs): Remove references to @sentry/tracing from READMEs #7600

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 5 commits into from
Mar 30, 2023
Merged

fix(docs): Remove references to @sentry/tracing from READMEs #7600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3aa889c
remove `@sentry/tracing` from readmes
timfish Mar 23, 2023
5511d7a
Merge branch 'develop' into feat/tracing/readme
timfish Mar 23, 2023
e82641d
Better wording
timfish Mar 23, 2023
4ddedd1
Code review changes
timfish Mar 24, 2023
0cb6c20
Merge remote-tracking branch 'upstream/develop' into feat/tracing/readme
timfish Mar 24, 2023
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
15 changes: 7 additions & 8 deletions packages/angular-ivy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,26 +80,25 @@ 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
will not work. The service itself tracks route changes and durations, where directive and decorators are tracking
components initializations.
`@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 SDK's
`TraceService` itself tracks route changes and durations, while directive and decorators are tracking components
initializations.

#### Install

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,
}),
Expand Down
13 changes: 6 additions & 7 deletions packages/angular/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,26 +76,25 @@ 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
will not work. The service itself tracks route changes and durations, where directive and decorators are tracking
`@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 SDK's `TraceService` itself tracks route changes and durations, while directive and decorators are tracking
components initializations.

#### Install

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,
}),
Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down
4 changes: 2 additions & 2 deletions packages/react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ export default App;

### Profiler

`@sentry/react` exports a Profiler component that leverages the `@sentry/tracing` Tracing integration to add React related
spans to transactions. If the Tracing integration is not enabled, the Profiler component will not work. The Profiler
`@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.

> app.js
Expand Down
3 changes: 1 addition & 2 deletions packages/svelte/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: "[email protected]",
integrations: [new BrowserTracing()],
integrations: [new Sentry.BrowserTracing()],

// Set tracesSampleRate to 1.0 to capture 100%
// of transactions for performance monitoring.
Expand Down