Replace `Hub` docs with `Scopes` by adinauer · Pull Request #12377 · getsentry/sentry-docs

adinauer · 2025-01-17T04:59:32Z

Since Hub has been deprecated in v8, we're replacing/removing docs.
This also documents the new scope types (global, isolation, current).

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

Urgent deadline (GA date, etc.):
Other deadline:
None: Not urgent, can wait up to 1 week+

SLA

Teamwork makes the dream work, so please add a reviewer to your PRs.
Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

Checked Vercel preview for correctness, including links
PR was reviewed and approved by any necessary SMEs (subject matter experts)
PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Sentry Docs contributor guide

vercel · 2025-01-17T04:59:37Z

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	Jan 20, 2025 2:13pm

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
changelog	⬜️ Ignored (Inspect)	Visit Preview		Jan 20, 2025 2:13pm
develop-docs	⬜️ Ignored (Inspect)	Visit Preview		Jan 20, 2025 2:13pm

codecov · 2025-01-17T05:01:10Z

Bundle Report

Changes will decrease total bundle size by 255.4kB (-1.26%) ⬇️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
sentry-docs-server-cjs	10.37MB	255.4kB (-2.4%) ⬇️

docs/platforms/android/enriching-events/scopes/index.mdx

lbloder · 2025-01-17T09:06:44Z

docs/platforms/android/enriching-events/scopes/index.mdx

-The default SDK integrations will push and pop scopes intelligently. For
-instance web framework integrations will create and destroy scopes around your
-routes or controllers.
+```java


Should we also add Kotlin samples here?

Yeah, let's do it in a follow up PR, I've created getsentry/sentry-java#4067 so we don't forget.

lbloder · 2025-01-17T09:12:05Z

docs/platforms/java/common/enriching-events/scopes/index.mdx

+
+You can modify the isolation scope via `Sentry.configureScope(ScopeType.ISOLATION, isolationScope -> { ... })`, but usually you'll just use the `Sentry.setXXX` methods to set data on the currently active isolation scope:
+
+```java


Should we also add a Kotlin sample here?

Yeah, let's do it in a follow up PR, I've created getsentry/sentry-java#4067 so we don't forget.

lbloder · 2025-01-17T09:12:12Z

docs/platforms/java/common/enriching-events/scopes/index.mdx

+
+The current scope is the local scope that is currently active. Unlike the rarely-forked isolation scope, the current scope may be forked more frequently and under the hood. It can be used to store data that should only be applied to specific events. In most cases, you should not access this scope directly, but use `Sentry.withScope` to create a new scope that is only active for a specific part of your code:
+
+```java


Should we also add a Kotlin sample here?

Yeah, let's do it in a follow up PR, I've created getsentry/sentry-java#4067 so we don't forget.

lbloder · 2025-01-17T09:12:36Z

docs/platforms/java/common/enriching-events/scopes/index.mdx

+
+Note, there are exceptions to this, where values from all scopes are merged. This is the case for breadcrumbs, tags, extras, contexts, attachments and event processors.
+
+```java


Should we also add a Kotlin sample here?

Yeah, let's do it in a follow up PR, I've created getsentry/sentry-java#4067 so we don't forget.

platform-includes/enriching-events/scopes/with-isolation-scope/java.mdx

platform-includes/enriching-events/scopes/with-scope/java.mdx

docs/platforms/java/common/enriching-events/scopes/index.mdx

docs/platforms/android/enriching-events/scopes/index.mdx

lbloder · 2025-01-17T09:46:40Z

docs/platforms/java/common/enriching-events/scopes/index.mdx

 </Alert>

+
 ## Kotlin Coroutines


Should Coroutines also be mentioned on the Android side?

Not sure, can ask Android folks

Created getsentry/sentry-java#4073

docs/platforms/android/enriching-events/scopes/index.mdx

coolguyzone · 2025-01-17T20:23:04Z

docs/platforms/android/enriching-events/scopes/index.mdx

+- [Isolation scope](#isolation-scope)
+- [Current scope](#current-scope)
+
+The Android SDK does not fork scopes on its own so you may set data on any of the scopes. The default the SDK writes to from its top level API is [current scope](#current-scope).


"The default the SDK writes to from its top level API is current scope"

Could this sentence be rephrased? I'm having trouble understanding the 'writes to from' phrase, and I'm also wondering if there's a subject missing here, should it be 'The default scope the SDK writes to'?

Thanks, I replaced it with "The Android SDK writes to current scope by default when using top level.".

Please let me know if you would like to see any further changes on it.

docs/platforms/android/enriching-events/scopes/index.mdx

docs/platforms/java/common/enriching-events/scopes/index.mdx

platform-includes/enriching-events/scopes/with-isolation-scope/java.mdx

coolguyzone

Thanks for the updates! Added some suggestions, overall looks good!

Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com>

Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com>

docs/platforms/android/enriching-events/scopes/index.mdx

lbloder

LGTM 👍

* Update Java SDK v8 deprecation removals (#11820) * Update Java SDK v8 deprecation removals * Update docs/platforms/android/configuration/options.mdx Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> --------- Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> * Add documentation on how to check-in to an environment with CheckInUtils (#11826) * Remove `enableTracing` option from Java SDK as it has been removed in v8 (#11575) * Update OpenTelemetry docs for Java v8 (#12209) * Update OTel docs for Java v8 * Apply suggestions from code review Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> --------- Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> * Document `forceInit` for Java SDK (#12260) * document forceInit option * Apply suggestions from code review Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> --------- Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> * Improve `bindToScope` docs for Java (#12263) * Improve bindToScope docs * Apply suggestions from code review Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> --------- Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> * Docs for `sentry-graphql-22` (#12259) * Duplicate docs for graphql-java v22 * link between graphql docs versions * Apply suggestions from code review Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> --------- Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> * Update platform docs for v8 and use OpenTelemetry (#12232) * Update OTel docs for Java v8 * Change platform docs for v8 and use OTel * move includes to index file * CR changes * [getsentry/action-github-commit] Auto commit * close ConfigKey tag * replace link * fix link * Update Android SDK "Using Sentry within an SDK" section for Java SDK v8 (#12325) * Update Using Sentry within an SDK for v8 * Update docs/platforms/android/configuration/shared-environments.mdx Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> --------- Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> * Add documentation on setting SpanKind and capture HttpHeaders with OTEL (#12328) * wip add docs for capturing http headers as well as manual instrumentation using opentelemetry * Update docs/platforms/java/common/tracing/instrumentation/opentelemetry.mdx Co-authored-by: Alexander Dinauer <adinauer@users.noreply.github.com> --------- Co-authored-by: Alexander Dinauer <adinauer@users.noreply.github.com> * Replace `Hub` docs with `Scopes` (#12377) * Replace hub docs with scopes docs * Apply suggestions from code review Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> * Apply suggestions from code review Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> * Update docs/platforms/android/enriching-events/scopes/index.mdx * duplicate java into android * Update docs/platforms/android/enriching-events/scopes/index.mdx --------- Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> --------- Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> Co-authored-by: Max Hovens <14804474+maxhov@users.noreply.github.com> Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>

* Update Java SDK v8 deprecation removals (#11820) * Update Java SDK v8 deprecation removals * Update docs/platforms/android/configuration/options.mdx Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> --------- Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> * Add documentation on how to check-in to an environment with CheckInUtils (#11826) * Remove `enableTracing` option from Java SDK as it has been removed in v8 (#11575) * Update OpenTelemetry docs for Java v8 (#12209) * Update OTel docs for Java v8 * Apply suggestions from code review Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> --------- Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> * Document `forceInit` for Java SDK (#12260) * document forceInit option * Apply suggestions from code review Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> --------- Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> * Improve `bindToScope` docs for Java (#12263) * Improve bindToScope docs * Apply suggestions from code review Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> --------- Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> * Docs for `sentry-graphql-22` (#12259) * Duplicate docs for graphql-java v22 * link between graphql docs versions * Apply suggestions from code review Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> --------- Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> * Update platform docs for v8 and use OpenTelemetry (#12232) * Update OTel docs for Java v8 * Change platform docs for v8 and use OTel * move includes to index file * CR changes * [getsentry/action-github-commit] Auto commit * close ConfigKey tag * replace link * fix link * Update Android SDK "Using Sentry within an SDK" section for Java SDK v8 (#12325) * Update Using Sentry within an SDK for v8 * Update docs/platforms/android/configuration/shared-environments.mdx Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> --------- Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> * Add documentation on setting SpanKind and capture HttpHeaders with OTEL (#12328) * wip add docs for capturing http headers as well as manual instrumentation using opentelemetry * Update docs/platforms/java/common/tracing/instrumentation/opentelemetry.mdx Co-authored-by: Alexander Dinauer <adinauer@users.noreply.github.com> --------- Co-authored-by: Alexander Dinauer <adinauer@users.noreply.github.com> * Replace `Hub` docs with `Scopes` (#12377) * Replace hub docs with scopes docs * Apply suggestions from code review Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> * Apply suggestions from code review Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> * Update docs/platforms/android/enriching-events/scopes/index.mdx * duplicate java into android * Update docs/platforms/android/enriching-events/scopes/index.mdx --------- Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> * Restore Hub docs as versioned docs for v7 and prior --------- Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com> Co-authored-by: Max Hovens <14804474+maxhov@users.noreply.github.com> Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>

Replace hub docs with scopes docs

ca337f5

vercel bot deployed to Preview – sentry-docs January 17, 2025 05:10 View deployment

lbloder reviewed Jan 17, 2025

View reviewed changes

coolguyzone reviewed Jan 17, 2025

View reviewed changes

docs/platforms/android/enriching-events/scopes/index.mdx Outdated Show resolved Hide resolved

coolguyzone reviewed Jan 17, 2025

View reviewed changes

docs/platforms/android/enriching-events/scopes/index.mdx Outdated Show resolved Hide resolved

coolguyzone reviewed Jan 17, 2025

View reviewed changes

docs/platforms/android/enriching-events/scopes/index.mdx Outdated Show resolved Hide resolved

coolguyzone reviewed Jan 17, 2025

View reviewed changes

docs/platforms/java/common/enriching-events/scopes/index.mdx Outdated Show resolved Hide resolved

coolguyzone reviewed Jan 17, 2025

View reviewed changes

docs/platforms/java/common/enriching-events/scopes/index.mdx Outdated Show resolved Hide resolved

coolguyzone reviewed Jan 17, 2025

View reviewed changes

docs/platforms/java/common/enriching-events/scopes/index.mdx Outdated Show resolved Hide resolved

coolguyzone reviewed Jan 17, 2025

View reviewed changes

platform-includes/enriching-events/scopes/with-isolation-scope/java.mdx Outdated Show resolved Hide resolved

coolguyzone approved these changes Jan 17, 2025

View reviewed changes

adinauer and others added 2 commits January 20, 2025 10:22

Apply suggestions from code review

9507afe

Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io> Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com>

Apply suggestions from code review

7be7607

Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com>

adinauer commented Jan 20, 2025

View reviewed changes

docs/platforms/android/enriching-events/scopes/index.mdx Outdated Show resolved Hide resolved

Update docs/platforms/android/enriching-events/scopes/index.mdx

b2408eb

adinauer mentioned this pull request Jan 20, 2025

Translate some Java code samples in docs to Kotlin getsentry/sentry-java#4067

Closed

vercel bot deployed to Preview – sentry-docs January 20, 2025 09:51 View deployment

duplicate java into android

15110d7

adinauer commented Jan 20, 2025

View reviewed changes

docs/platforms/android/enriching-events/scopes/index.mdx Outdated Show resolved Hide resolved

Update docs/platforms/android/enriching-events/scopes/index.mdx

b86db1b

lbloder approved these changes Jan 20, 2025

View reviewed changes

vercel bot deployed to Preview – sentry-docs January 20, 2025 14:13 View deployment

adinauer merged commit b4e9e08 into feat/java-v8-changes Jan 20, 2025
2 checks passed

adinauer deleted the feat/java-sdk-v8-scopes branch January 20, 2025 14:40

github-actions bot locked and limited conversation to collaborators Feb 5, 2025


		You can modify the isolation scope via `Sentry.configureScope(ScopeType.ISOLATION, isolationScope -> { ... })`, but usually you'll just use the `Sentry.setXXX` methods to set data on the currently active isolation scope:

		```java


		The current scope is the local scope that is currently active. Unlike the rarely-forked isolation scope, the current scope may be forked more frequently and under the hood. It can be used to store data that should only be applied to specific events. In most cases, you should not access this scope directly, but use `Sentry.withScope` to create a new scope that is only active for a specific part of your code:

		```java


		Note, there are exceptions to this, where values from all scopes are merged. This is the case for breadcrumbs, tags, extras, contexts, attachments and event processors.

		```java

Uh oh!

Conversation

adinauer commented Jan 17, 2025

DESCRIBE YOUR PR

IS YOUR CHANGE URGENT?

SLA

PRE-MERGE CHECKLIST

LEGAL BOILERPLATE

EXTRA RESOURCES

Uh oh!

vercel bot commented Jan 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jan 17, 2025

Bundle Report

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coolguyzone left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lbloder left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vercel bot commented Jan 17, 2025 •

edited

Loading