chore: Add migration docs for Hub
#10126
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Lms24
reviewed
Jan 10, 2024
Co-authored-by: Lukas Stracke <lukas.stracke@sentry.io>
mydea
reviewed
Jan 10, 2024
MIGRATION.md
Outdated
| | `new Hub()` | `withScope()`, `withIsolationScope()` or `new Scope()` | | ||
| | hub.isOlderThan() | REMOVED - Was used to compare `Hub` instances, which are gonna be removed. | | ||
| | hub.bindClient() | A combination of `scope.setClient()` and `client.setupIntegrations()` | | ||
| | hub.pushScope() | Best replaced with `withScope()` | |
There was a problem hiding this comment.
Suggested change
| | hub.pushScope() | Best replaced with `withScope()` | | |
| | hub.pushScope() | `Sentry.withScope()` | |
mydea
reviewed
Jan 10, 2024
MIGRATION.md
Outdated
| | hub.isOlderThan() | REMOVED - Was used to compare `Hub` instances, which are gonna be removed. | | ||
| | hub.bindClient() | A combination of `scope.setClient()` and `client.setupIntegrations()` | | ||
| | hub.pushScope() | Best replaced with `withScope()` | | ||
| | hub.popScope() | When used in combination with `hub.pushScope()` best replaced with `withScope()` | |
There was a problem hiding this comment.
Suggested change
| | hub.popScope() | When used in combination with `hub.pushScope()` best replaced with `withScope()` | | |
| | hub.popScope() | `Sentry.withScope()` | |
mydea
reviewed
Jan 10, 2024
MIGRATION.md
Outdated
| | hub.pushScope() | Best replaced with `withScope()` | | ||
| | hub.popScope() | When used in combination with `hub.pushScope()` best replaced with `withScope()` | | ||
| | hub.withScope() | `withScope()` | | ||
| | getClient() | `scope.getClient` | |
There was a problem hiding this comment.
Suggested change
| | getClient() | `scope.getClient` | | |
| | getClient() | `Sentry.getClient()` | |
There was a problem hiding this comment.
users should never use scope.getClient() in the future, as we want to cascade the clients in v8 (so it is only set on the isolation scope).
mydea
reviewed
Jan 10, 2024
MIGRATION.md
Outdated
| | hub.popScope() | When used in combination with `hub.pushScope()` best replaced with `withScope()` | | ||
| | hub.withScope() | `withScope()` | | ||
| | getClient() | `scope.getClient` | | ||
| | getScope() | REMOVED - Scopes are used directly now. | |
There was a problem hiding this comment.
Suggested change
| | getScope() | REMOVED - Scopes are used directly now. | | |
| | getScope() | `Sentry.getCurrentScope()` to get the currently active scope | |
mydea
reviewed
Jan 10, 2024
MIGRATION.md
Outdated
| | hub.bindClient() | A combination of `scope.setClient()` and `client.setupIntegrations()` | | ||
| | hub.pushScope() | Best replaced with `withScope()` | | ||
| | hub.popScope() | When used in combination with `hub.pushScope()` best replaced with `withScope()` | | ||
| | hub.withScope() | `withScope()` | |
There was a problem hiding this comment.
Suggested change
| | hub.withScope() | `withScope()` | | |
| | hub.withScope() | `Sentry.withScope()` | |
mydea
reviewed
Jan 10, 2024
MIGRATION.md
Outdated
Comment on lines
34
to
36
| | captureException() | `scope.captureException()` | | ||
| | captureMessage() | `scope.captureMessage()` | | ||
| | captureEvent() | `scope.captureEvent()` | |
There was a problem hiding this comment.
Suggested change
| | captureException() | `scope.captureException()` | | |
| | captureMessage() | `scope.captureMessage()` | | |
| | captureEvent() | `scope.captureEvent()` | | |
| | captureException() | `Sentry.captureException()` | | |
| | captureMessage() | `Sentry.captureMessage()` | | |
| | captureEvent() | `Sentry.captureEvent()` | |
IMHO users should avoid using these on the scope directly, just use the global methods.
mydea
reviewed
Jan 10, 2024
MIGRATION.md
Outdated
Comment on lines
38
to
44
| | addBreadcrumb() | `scope.addBreadcrumb()` | | ||
| | setUser() | `scope.setUser()` | | ||
| | setTags() | `scope.setTags()` | | ||
| | setExtras() | `scope.setExtras()` | | ||
| | setTag() | `scope.setTag()` | | ||
| | setExtra() | `scope.setExtra()` | | ||
| | setContext() | `scope.setContext()` | |
There was a problem hiding this comment.
Suggested change
| | addBreadcrumb() | `scope.addBreadcrumb()` | | |
| | setUser() | `scope.setUser()` | | |
| | setTags() | `scope.setTags()` | | |
| | setExtras() | `scope.setExtras()` | | |
| | setTag() | `scope.setTag()` | | |
| | setExtra() | `scope.setExtra()` | | |
| | setContext() | `scope.setContext()` | | |
| | addBreadcrumb() | `Sentry.addBreadcrumb()` | | |
| | setUser() | `Sentry.setUser()` | | |
| | setTags() | `Sentry.setTags()` | | |
| | setExtras() | `Sentry.setExtras()` | | |
| | setTag() | `Sentry.setTag()` | | |
| | setExtra() | `Sentry.setExtra()` | | |
| | setContext() | `Sentry.setContext()` | |
mydea
reviewed
Jan 10, 2024
MIGRATION.md
Outdated
| | setExtra() | `scope.setExtra()` | | ||
| | setContext() | `scope.setContext()` | | ||
| | configureScope() | REMOVED - Scopes are now the unit of concurrency. | | ||
| | run() | `withScope()` or `withIsolationScope()` | |
There was a problem hiding this comment.
Suggested change
| | run() | `withScope()` or `withIsolationScope()` | | |
| | run() | `Sentry.withScope()` or `Sentry.withIsolationScope()` | |
mydea
reviewed
Jan 10, 2024
MIGRATION.md
Outdated
| | configureScope() | REMOVED - Scopes are now the unit of concurrency. | | ||
| | run() | `withScope()` or `withIsolationScope()` | | ||
| | getIntegration() | `client.getIntegration()` | | ||
| | startTransaction() | `startSpan()`, `startInactiveSpan()` or `startSpanManual()` | |
There was a problem hiding this comment.
Suggested change
| | startTransaction() | `startSpan()`, `startInactiveSpan()` or `startSpanManual()` | | |
| | startTransaction() | `Sentry.startSpan()`, `Sentry.startInactiveSpan()` or `Sentry.startSpanManual()` | |
mydea
approved these changes
Jan 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds documentation on how to migrate off the hub API to the MIGRATION guide. This is still a bit basic - we will expand on this once we have figured out all of our migration paths and are finalizing v8.