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.

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

Jump to bottom

Add note about integrations to multiple clients js doc #10355

Merged
merged 2 commits into from
Jun 12, 2024
Merged

Add note about integrations to multiple clients js doc #10355

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fde1148
Add note about integrations to multiple clients js doc
AbhiPrasad Jun 11, 2024
37d1e06
change export
AbhiPrasad Jun 12, 2024
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
45 changes: 35 additions & 10 deletions docs/platforms/javascript/common/best-practices/multiple-sentry-instances.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,12 @@ keywords:
"Browser Extension",
"VSCode Extension",
"Widgets",
"monorepo"
"monorepo",
]
---

These best practices are relevant for you if you set up Sentry in one of the following use-cases:

- Browser Extensions
- VSCode Extensions
- Third-Party Widgets
Expand All @@ -40,30 +41,42 @@ Creating multiple Sentry clients is **not recommended** in general, as it can le

To be able to manage several Sentry instances without any conflicts between them you need to create your own `Client`.
This also helps to prevent tracking of any parent application errors in case your application is integrated
inside of it. In this example we use `BrowserClient` from `@sentry/browser` but it's also applicable to `NodeClient` from `@sentry/node`.
inside of it. To ensure you don't conflict with your parent application, you should also remove any integrations that rely on global state.

In this example we use `BrowserClient` from `@sentry/browser` but it's also applicable to `NodeClient` from `@sentry/node`.

<SignInNote />

```javascript
import {
BrowserClient,
defaultStackParser,
defaultIntegrations,
getDefaultIntegrations,
makeFetchTransport,
Scope,
} from "@sentry/browser";

// filter integrations that use the global variable
const integrations = getDefaultIntegrations({}).filter((defaultIntegration) => {
return ![
"BrowserApiErrors",
"TryCatch",
"Breadcrumbs",
"GlobalHandlers",
].includes(defaultIntegration.name);
});

const client = new BrowserClient({
dsn: "___PUBLIC_DSN___",
transport: makeFetchTransport,
stackParser: defaultStackParser,
integrations: defaultIntegrations,
integrations: integrations,
Copy link
Member

Choose a reason for hiding this comment

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

Maybe you want to write it this way, but I leave it up to you

Suggested change
integrations: integrations,
integrations,

Copy link
Member Author

Choose a reason for hiding this comment

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

I thought about this, but this makes it especially explicit we are passing in this variable here. I'll leave this syntax for people who are less familiar with JS.

});

const scope = new Scope();
scope.setClient(client);

client.init() // initializing has to be done after setting the client on the scope
client.init(); // initializing has to be done after setting the client on the scope

// You can capture exceptions manually for this client like this:
scope.captureException(new Error("example"));
Expand All @@ -86,7 +99,7 @@ import * as Sentry from "@sentry/browser";
// Very happy integration that'll prepend and append very happy stick figure to the message
function happyIntegration() {
return {
name: 'Happy',
name: "Happy",
setupOnce() {
Sentry.addEventProcessor((event) => {
const self = Sentry.getClient().getIntegration(HappyIntegration);
Expand All @@ -96,15 +109,27 @@ function happyIntegration() {
}
return event;
});
}
}
},
};
}

// filter integrations that use the global variable
const integrations = Sentry.getDefaultIntegrations({}).filter(
(defaultIntegration) => {
return ![
"BrowserApiErrors",
"TryCatch",
"Breadcrumbs",
"GlobalHandlers",
].includes(defaultIntegration.name);
}
);

const client1 = new Sentry.BrowserClient({
dsn: "___PUBLIC_DSN___",
transport: Sentry.makeFetchTransport,
stackParser: Sentry.defaultStackParser,
integrations: [...Sentry.defaultIntegrations, happyIntegration()],
integrations: [...integrations, happyIntegration()],
beforeSend(event) {
console.log("client 1", event);
return null; // Returning `null` prevents the event from being sent
Expand All @@ -116,7 +141,7 @@ const client2 = new Sentry.BrowserClient({
dsn: "___PUBLIC_DSN___", // Can be a different DSN
transport: Sentry.makeFetchTransport,
stackParser: Sentry.defaultStackParser,
integrations: [...Sentry.defaultIntegrations, happyIntegration()],
integrations: [...integrations, happyIntegration()],
beforeSend(event) {
console.log("client 2", event);
return null; // Returning `null` prevents the event from being sent
Expand Down
Loading