Skip to content

fix: Update docs for manual client creation #8495

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.

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 2 commits into from
Nov 16, 2023
Merged

fix: Update docs for manual client creation #8495

merged 2 commits into from
Nov 16, 2023

Conversation

mydea
Copy link
Member

@mydea mydea commented Nov 15, 2023

We noticed these docs were actually incorrect, because you basically have to call new Hub(client) - if you don't do this, integrations will not run, which will/may lead to unintended side effects. So updating this to just document this as "the" way to do this.

While at this, I also updated this to specifically call out browser extensions, as that is a common thing we get requests for every now and then, and also point out that in addition you should not setup any global integrations in such a scenario.

@mydea mydea requested review from lforst, Lms24 and a team November 15, 2023 09:51
@mydea mydea self-assigned this Nov 15, 2023
Copy link

vercel bot commented Nov 15, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 16, 2023 8:21am

Copy link
Contributor

@shanamatthews shanamatthews left a comment

Choose a reason for hiding this comment

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

Just some small phrasing tweaks, otherwise lgtm!

@mydea mydea merged commit 1087eb8 into master Nov 16, 2023
@mydea mydea deleted the fn/manual-client branch November 16, 2023 08:57
mydea added a commit to getsentry/sentry-javascript that referenced this pull request Nov 16, 2023
While debugging something, figured it is good to have a test covering
that this works as expected!

See also: getsentry/sentry-docs#8495
@github-actions github-actions bot locked and limited conversation to collaborators Dec 2, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants