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

Emit deprecation warnings for Hub-based APIs #3265

Closed
szokeasaurusrex opened this issue Jul 10, 2024 · 1 comment · Fixed by #3280
Closed

Emit deprecation warnings for Hub-based APIs #3265

szokeasaurusrex opened this issue Jul 10, 2024 · 1 comment · Fixed by #3280
Assignees
@szokeasaurusrex

Comments

@szokeasaurusrex
Copy link
Member

Per our documentation, all Hub-based APIs have been deprecated since 2.0.0, but we have not been emitting deprecation warnings yet, because we still use Hub APIs in a few places.

We should add deprecation warnings for all Hub-based APIs.

Before we can do this, we need to remove all remaining Hub API usages (besides those needed for backwards-compatibility) from the SDK.
This was referenced Jul 10, 2024
Merged
Merged
szokeasaurusrex added a commit that referenced this issue Jul 10, 2024
@szokeasaurusrex
ref(tracing): Remove Hub in Transaction.finish
14970d8 
Rename `Transaction.finish` method's `hub` parameter to `scope` (in a backwards-compatible manner), and update the method so that it is using `Scope` API under the hood as much as possible.

Prerequisite for #3265
@szokeasaurusrex szokeasaurusrex mentioned this issue Jul 10, 2024
Merged
szokeasaurusrex added a commit that referenced this issue Jul 10, 2024
@szokeasaurusrex
ref(tracing): Remove Hub in Transaction.finish
cfe647f 
Rename `Transaction.finish` method's `hub` parameter to `scope` (in a backwards-compatible manner), and update the method so that it is using `Scope` API under the hood as much as possible.

Prerequisite for #3265
szokeasaurusrex added a commit that referenced this issue Jul 10, 2024
@szokeasaurusrex
ref: Stop using Hub in tracing_utils
a9cff08 
Get the client via `sentry_sdk.get_client()` instead.

Prerequisite for #3265
@szokeasaurusrex szokeasaurusrex mentioned this issue Jul 10, 2024
Merged
szokeasaurusrex added a commit that referenced this issue Jul 10, 2024
@szokeasaurusrex
ref: Stop using Hub in tracing_utils (#3269)
9d97d93 
Get the client via `sentry_sdk.get_client()` instead.

Prerequisite for #3265
szokeasaurusrex added a commit that referenced this issue Jul 10, 2024
@szokeasaurusrex
ref(profiling): Deprecate hub in Profile
9fe64ac 
Related to #3265
@szokeasaurusrex szokeasaurusrex mentioned this issue Jul 10, 2024
Merged
@szokeasaurusrex szokeasaurusrex self-assigned this Jul 10, 2024
szokeasaurusrex added a commit that referenced this issue Jul 10, 2024
@szokeasaurusrex
ref(tracing): Remove Hub in Transaction.finish
3461068 
Rename `Transaction.finish` method's `hub` parameter to `scope` (in a backwards-compatible manner), and update the method so that it is using `Scope` API under the hood as much as possible.

Prerequisite for #3265
@szokeasaurusrex szokeasaurusrex mentioned this issue Jul 10, 2024
Merged
szokeasaurusrex added a commit that referenced this issue Jul 11, 2024
@szokeasaurusrex
ref(profiling): Deprecate hub in Profile
d64eb24 
Related to #3265
szokeasaurusrex added a commit that referenced this issue Jul 11, 2024
@szokeasaurusrex
ref(profiling): Deprecate hub in Profile (#3270)
06d5da1 
Related to #3265
@szokeasaurusrex
Copy link
Member Author

Following offline discussion with @antonpirker, we will only warn when:

  • Calling Hub.__init__
  • Accessing Hub.current or Hub.main

The idea here is that all other Hub APIs can only be accessed after obtaining a Hub object, which one can only do with one of the above methods. Once we have warned the user once that using the Hub is deprecated, we don't need to warn every other time they call a method on the hub.

szokeasaurusrex added a commit that referenced this issue Jul 11, 2024
@szokeasaurusrex
feat(hub): Emit deprecation warnings from Hub API
fee1fd7 
`sentry_sdk.Hub` has been deprecated since Sentry SDK version 2.0.0 per our docs; however, we waited with adding deprecation warnings because the SDK itself was still using `Hub` APIs until recently.

Since we no longer use `Hub` APIs in the SDK (except in `Hub` APIs which are themselves deprecated), we can now start emitting deprecation warnings.

Closes #3265
@szokeasaurusrex szokeasaurusrex mentioned this issue Jul 11, 2024
Merged
szokeasaurusrex added a commit that referenced this issue Jul 16, 2024
@szokeasaurusrex
feat(hub): Emit deprecation warnings from Hub API
556a1fd 
`sentry_sdk.Hub` has been deprecated since Sentry SDK version 2.0.0 per our docs; however, we waited with adding deprecation warnings because the SDK itself was still using `Hub` APIs until recently.

Since we no longer use `Hub` APIs in the SDK (except in `Hub` APIs which are themselves deprecated), we can now start emitting deprecation warnings.

Closes #3265
szokeasaurusrex added a commit that referenced this issue Jul 16, 2024
@szokeasaurusrex
feat(hub): Emit deprecation warnings from Hub API
da15b63 
`sentry_sdk.Hub` has been deprecated since Sentry SDK version 2.0.0 per our docs; however, we waited with adding deprecation warnings because the SDK itself was still using `Hub` APIs until recently.

Since we no longer use `Hub` APIs in the SDK (except in `Hub` APIs which are themselves deprecated), we can now start emitting deprecation warnings.

Closes #3265
szokeasaurusrex added a commit that referenced this issue Jul 22, 2024
@szokeasaurusrex
feat(hub): Emit deprecation warnings from Hub API (#3280)
52e4e23 
`sentry_sdk.Hub` has been deprecated since Sentry SDK version 2.0.0 per our docs; however, we waited with adding deprecation warnings because the SDK itself was still using `Hub` APIs until recently.

Since we no longer use `Hub` APIs in the SDK (except in `Hub` APIs which are themselves deprecated), we can now start emitting deprecation warnings.

Closes #3265
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@szokeasaurusrex szokeasaurusrex

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(hub): Emit deprecation warnings from Hub API getsentry/sentry-python
1 participant
@szokeasaurusrex