Merge branch 'release/2.0.0'

getsentry · Apr 25, 2024 · 439d418 · 439d418
2 parents 74310f0 + 38bbb8d
commit 439d418
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 294 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,191 +1,22 @@
 # Changelog
 
-## 2.0.0rc6
+## 2.0.0
 
-### Various fixes & improvements
-
-- Restore original behavior by always creating a span (#3005) by @antonpirker
-- Merge baggage headers (incoming and new created ones) (#3001) by @antonpirker
-- Fix duplicate baggage headers in Celery integration introduced in SDK 2.0 (#2993) by @antonpirker
-- Make it work with old and new newrelic versions (#2999) by @antonpirker
-- docs: Update migration guide wording (#2987) by @colin-sentry
-- docs: Tweak migration guide (#2979) by @colin-sentry
-- Small updates to migration guide (#2911) by @colin-sentry
-- Update CHANGELOG.md (51a906c1) by @sentrivana
-- release: 1.45.0 (7570e39a) by @getsentry-bot
-
-## 2.0.0rc5
-
-## New Features
-
-- Additional integrations will now be activated automatically if the SDK detects the respective package is installed: Ariadne, ARQ, asyncpg, Chalice, clickhouse-driver, GQL, Graphene, huey, Loguru, PyMongo, Quart, Starlite, Strawberry.
-- Added new API for custom instrumentation: `new_scope`, `isolation_scope`. See the [Deprecated](#deprecated) section to see how they map to the existing APIs.
-
-## Changed
-
-- The Pyramid integration will not capture errors that might happen in `authenticated_userid()` in a custom `AuthenticationPolicy` class.
-- The method `need_code_loation` of the `MetricsAggregator` was renamed to `need_code_location`.
-- The `BackgroundWorker` thread used to process events was renamed from `raven-sentry.BackgroundWorker` to `sentry-sdk.BackgroundWorker`.
-- The `reraise` function was moved from `sentry_sdk._compat` to `sentry_sdk.utils`.
-- The `_ScopeManager` was moved from `sentry_sdk.hub` to `sentry_sdk.scope`.
-- Moved the contents of `tracing_utils_py3.py` to `tracing_utils.py`. The `start_child_span_decorator` is now in `sentry_sdk.tracing_utils`.
-- The actual implementation of `get_current_span` was moved to `sentry_sdk.tracing_utils`. `sentry_sdk.get_current_span` is still accessible as part of the top-level API.
-- `sentry_sdk.tracing_utils.add_query_source()`: Removed the `hub` parameter. It is not necessary anymore.
-- `sentry_sdk.tracing_utils.record_sql_queries()`: Removed the `hub` parameter. It is not necessary anymore.
-- `sentry_sdk.tracing_utils.get_current_span()` does now take a `scope` instead of a `hub` as parameter.
-- `sentry_sdk.tracing_utils.should_propagate_trace()` now takes a `Client` instead of a `Hub` as first parameter.
-- `sentry_sdk.utils.is_sentry_url()` now takes a `Client` instead of a `Hub` as first parameter.
-- `sentry_sdk.utils._get_contextvars` does not return a tuple with three values, but a tuple with two values. The `copy_context` was removed.
-- If you create a transaction manually and later mutate the transaction in a `configure_scope` block this does not work anymore. Here is a recipe on how to change your code to make it work:
-    Your existing implementation:
-    ```python
-    transaction = sentry_sdk.transaction(...)
-
-    # later in the code execution:
-
-    with sentry_sdk.configure_scope() as scope:
-        scope.set_transaction_name("new-transaction-name")
-    ```
-
-    needs to be changed to this:
-    ```python
-    transaction = sentry_sdk.transaction(...)
-
-    # later in the code execution:
-
-    scope = sentry_sdk.Scope.get_current_scope()
-    scope.set_transaction_name("new-transaction-name")
-    ```
-- The classes listed in the table below are now abstract base classes. Therefore, they can no longer be instantiated. Subclasses can only be instantiated if they implement all of the abstract methods.
-  <details>
-    <summary><b>Show table</b></summary>
-
-  | Class                                 | Abstract methods                       |
-  | ------------------------------------- | -------------------------------------- |
-  | `sentry_sdk.integrations.Integration` | `setup_once`                           |
-  | `sentry_sdk.metrics.Metric`           | `add`, `serialize_value`, and `weight` |
-  | `sentry_sdk.profiler.Scheduler`       | `setup` and `teardown`                 |
-  | `sentry_sdk.transport.Transport`      | `capture_envelope`                     |
-
-    </details>
-
-## Removed
-
-- Removed support for Python 2 and Python 3.5. The SDK now requires at least Python 3.6.
-- Removed support for Celery 3.\*.
-- Removed support for Django 1.8, 1.9, 1.10.
-- Removed support for Flask 0.\*.
-- Removed support for gRPC < 1.39.
-- Removed support for Tornado < 6.
-- Removed `last_event_id()` top level API. The last event ID is still returned by `capture_event()`, `capture_exception()` and `capture_message()` but the top level API `sentry_sdk.last_event_id()` has been removed.
-- Removed support for sending events to the `/store` endpoint. Everything is now sent to the `/envelope` endpoint. If you're on SaaS you don't have to worry about this, but if you're running Sentry yourself you'll need version `20.6.0` or higher of self-hosted Sentry.
-- The deprecated `with_locals` configuration option was removed. Use `include_local_variables` instead. See https://docs.sentry.io/platforms/python/configuration/options/#include-local-variables.
-- The deprecated `request_bodies` configuration option was removed. Use `max_request_body_size`. See https://docs.sentry.io/platforms/python/configuration/options/#max-request-body-size.
-- Removed support for `user.segment`. It was also removed from the trace header as well as from the dynamic sampling context.
-- Removed support for the `install` method for custom integrations. Please use `setup_once` instead.
-- Removed `sentry_sdk.tracing.Span.new_span`. Use `sentry_sdk.tracing.Span.start_child` instead.
-- Removed `sentry_sdk.tracing.Transaction.new_span`. Use `sentry_sdk.tracing.Transaction.start_child` instead.
-- Removed support for creating transactions via `sentry_sdk.tracing.Span(transaction=...)`. To create a transaction, please use `sentry_sdk.tracing.Transaction(name=...)`.
-- Removed `sentry_sdk.utils.Auth.store_api_url`.
-- `sentry_sdk.utils.Auth.get_api_url`'s now accepts a `sentry_sdk.consts.EndpointType` enum instead of a string as its only parameter. We recommend omitting this argument when calling the function, since the parameter's default value is the only possible `sentry_sdk.consts.EndpointType` value. The parameter exists for future compatibility.
-- Removed `tracing_utils_py2.py`. The `start_child_span_decorator` is now in `sentry_sdk.tracing_utils`.
-- Removed the `sentry_sdk.profiler.Scheduler.stop_profiling` method. Any calls to this method can simply be removed, since this was a no-op method.
-
-## Deprecated
-
-- Using the `Hub` directly as well as using hub-based APIs has been deprecated. Where available, use [the top-level API instead](sentry_sdk/api.py); otherwise use the [scope API](sentry_sdk/scope.py) or the [client API](sentry_sdk/client.py).
-
-  Before:
-
-  ```python
-  with hub.start_span(...):
-      # do something
-  ```
-
-  After:
-
-  ```python
-  import sentry_sdk
-
-  with sentry_sdk.start_span(...):
-      # do something
-  ```
-
-- Hub cloning is deprecated.
-
-  Before:
-
-  ```python
-  with Hub(Hub.current) as hub:
-      # do something with the cloned hub
-  ```
-
-  After:
-
-  ```python
-  import sentry_sdk
-
-  with sentry_sdk.isolation_scope() as scope:
-      # do something with the forked scope
-  ```
-
-- `configure_scope` is deprecated. Use the new isolation scope directly via `Scope.get_isolation_scope()` instead.
-
-  Before:
-
-  ```python
-  with configure_scope() as scope:
-      # do something with `scope`
-  ```
-
-  After:
-
-  ```python
-  from sentry_sdk.scope import Scope
-
-  scope = Scope.get_isolation_scope()
-  # do something with `scope`
-  ```
+This is the first major update in a *long* time! 
 
-- `push_scope` is deprecated. Use the new `new_scope` context manager to fork the necessary scopes.
+We dropped support for some ancient languages and frameworks (Yes, Python 2.7 is no longer supported). Additionally we refactored a big part of the foundation of the SDK (how data inside the SDK is handled).
 
-  Before:
+We hope you like it!
 
-  ```python
-  with push_scope() as scope:
-      # do something with `scope`
-  ```
+For a shorter version of what you need to do, to upgrade to Sentry SDK 2.0 see: https://docs.sentry.io/platforms/python/migration/1.x-to-2.x 
 
-  After:
-
-  ```python
-  import sentry_sdk
-
-  with sentry_sdk.new_scope() as scope:
-      # do something with `scope`
-  ```
-
-- Accessing the client via the hub has been deprecated. Use the top-level `sentry_sdk.get_client()` to get the current client.
-- `profiler_mode` and `profiles_sample_rate` have been deprecated as `_experiments` options. Use them as top level options instead:
-  ```python
-  sentry_sdk.init(
-      ...,
-      profiler_mode="thread",
-      profiles_sample_rate=1.0,
-  )
-  ```
-- Deprecated `sentry_sdk.transport.Transport.capture_event`. Please use `sentry_sdk.transport.Transport.capture_envelope`, instead.
-- Passing a function to `sentry_sdk.init`'s `transport` keyword argument has been deprecated. If you wish to provide a custom transport, please pass a `sentry_sdk.transport.Transport` instance or a subclass.
-- The parameter `propagate_hub` in `ThreadingIntegration()` was deprecated and renamed to `propagate_scope`.
-
-## 2.0.0rc4
-
-## New Features
+### New Features
 
 - Additional integrations will now be activated automatically if the SDK detects the respective package is installed: Ariadne, ARQ, asyncpg, Chalice, clickhouse-driver, GQL, Graphene, huey, Loguru, PyMongo, Quart, Starlite, Strawberry.
 - Added new API for custom instrumentation: `new_scope`, `isolation_scope`. See the [Deprecated](#deprecated) section to see how they map to the existing APIs.
 
-## Changed
+### Changed
+(These changes are all backwards-incompatible. **Breaking Change** (if you are just skimming for that phrase))
 
 - The Pyramid integration will not capture errors that might happen in `authenticated_userid()` in a custom `AuthenticationPolicy` class.
 - The method `need_code_loation` of the `MetricsAggregator` was renamed to `need_code_location`.
@@ -233,7 +64,8 @@
 
     </details>
 
-## Removed
+### Removed
+(These changes are all backwards-incompatible. **Breaking Change** (if you are just skimming for that phrase))
 
 - Removed support for Python 2 and Python 3.5. The SDK now requires at least Python 3.6.
 - Removed support for Celery 3.\*.
@@ -255,7 +87,7 @@
 - Removed `tracing_utils_py2.py`. The `start_child_span_decorator` is now in `sentry_sdk.tracing_utils`.
 - Removed the `sentry_sdk.profiler.Scheduler.stop_profiling` method. Any calls to this method can simply be removed, since this was a no-op method.
 
-## Deprecated
+### Deprecated
 
 - Using the `Hub` directly as well as using hub-based APIs has been deprecated. Where available, use [the top-level API instead](sentry_sdk/api.py); otherwise use the [scope API](sentry_sdk/scope.py) or the [client API](sentry_sdk/client.py).
 
@@ -342,118 +174,6 @@
 - Passing a function to `sentry_sdk.init`'s `transport` keyword argument has been deprecated. If you wish to provide a custom transport, please pass a `sentry_sdk.transport.Transport` instance or a subclass.
 - The parameter `propagate_hub` in `ThreadingIntegration()` was deprecated and renamed to `propagate_scope`.
 
-## 2.0.0rc3
-
-### Various fixes & improvements
-
-- Use new scopes API default integrations. (#2856) by @antonpirker
-- Use new scopes API in openai integration (#2853) by @antonpirker
-- Use new scopes API in Celery integration. (#2851) by @antonpirker
-- Use new scopes API in Django, SQLAlchemy, and asyncpg integration. (#2845) by @antonpirker
-- Use new scopes API in Redis (#2854) by @sentrivana
-- Use new scopes API in GQL Integration (#2838) by @szokeasaurusrex
-- Use new scopes API in LoggingIntegration (#2861, #2855) by @sentrivana
-- Use new scopes API in FastAPI integration (#2836) by @szokeasaurusrex
-- Use new scopes API in Ariadne (#2850) by @szokeasaurusrex
-- Add optional `keep_alive` (#2842) by @sentrivana
-- Add support for celery-redbeat cron tasks (#2643) by @kwigley
-- AWS Lambda: aws_event can be an empty list (#2849) by @sentrivana
-- GQL: Remove problematic tests (#2835) by @szokeasaurusrex
-- Moved `should_send_default_pii` into client (#2840) by @antonpirker
-- `should_send_default_pii` shortcut (#2844) by @szokeasaurusrex
-- Use `scope.should_send_default_pii` in FastAPI integration (#2846) by @szokeasaurusrex
-- Patched functions decorator for integrations (#2454) by @szokeasaurusrex
-- Small APIdocs improvement (#2828) by @antonpirker
-- Bump checkouts/data-schemas from `ed078ed` to `8232f17` (#2832) by @dependabot
-- Update CHANGELOG.md (970c5779) by @sentrivana
-- Updated migration guide (#2859) by @antonpirker
-
-_Plus 2 more_
-
-## 2.0.0rc2
-
-## New Features
-
-- Additional integrations will now be activated automatically if the SDK detects the respective package is installed: Ariadne, ARQ, asyncpg, Chalice, clickhouse-driver, GQL, Graphene, huey, Loguru, PyMongo, Quart, Starlite, Strawberry.
-
-## Changed
-
-- The Pyramid integration will not capture errors that might happen in `authenticated_userid()` in a custom `AuthenticationPolicy` class.
-- The method `need_code_loation` of the `MetricsAggregator` was renamed to `need_code_location`.
-- The `BackgroundWorker` thread used to process events was renamed from `raven-sentry.BackgroundWorker` to `sentry-sdk.BackgroundWorker`.
-- The `reraise` function was moved from `sentry_sdk._compat` to `sentry_sdk.utils`.
-- The `_ScopeManager` was moved from `sentry_sdk.hub` to `sentry_sdk.scope`.
-- Moved the contents of `tracing_utils_py3.py` to `tracing_utils.py`. The `start_child_span_decorator` is now in `sentry_sdk.tracing_utils`.
-- The actual implementation of `get_current_span` was moved to `sentry_sdk.tracing_utils`. `sentry_sdk.get_current_span` is still accessible as part of the top-level API.
-- `sentry_sdk.tracing_utils.get_current_span()` does now take a `scope` instead of a `hub` as parameter.
-- `sentry_sdk.utils._get_contextvars` does not return a tuple with three values, but a tuple with two values. The `copy_context` was removed.
-- If you create a transaction manually and later mutate the transaction in a `configure_scope` block this does not work anymore. Here is a recipe on how to change your code to make it work:
-    Your existing implementation:
-    ```python
-    transaction = sentry_sdk.transaction(...)
-
-    # later in the code execution:
-
-    with sentry_sdk.configure_scope() as scope:
-        scope.set_transaction_name("new-transaction-name")
-    ```
-
-    needs to be changed to this:
-    ```python
-    transaction = sentry_sdk.transaction(...)
-
-    # later in the code execution:
-
-    scope = sentry_sdk.Scope.get_current_scope()
-    scope.set_transaction_name("new-transaction-name")
-    ```
-- The classes listed in the table below are now abstract base classes. Therefore, they can no longer be instantiated. Subclasses can only be instantiated if they implement all of the abstract methods.
-  <details>
-    <summary><b>Show table</b></summary>
-
-  | Class                                 | Abstract methods                       |
-  | ------------------------------------- | -------------------------------------- |
-  | `sentry_sdk.integrations.Integration` | `setup_once`                           |
-  | `sentry_sdk.metrics.Metric`           | `add`, `serialize_value`, and `weight` |
-  | `sentry_sdk.profiler.Scheduler`       | `setup` and `teardown`                 |
-  | `sentry_sdk.transport.Transport`      | `capture_envelope`                     |
-
-    </details>
-
-## Removed
-
-- Removed support for Python 2 and Python 3.5. The SDK now requires at least Python 3.6.
-- Removed support for Celery 3.\*.
-- Removed support for Django 1.8, 1.9, 1.10.
-- Removed support for Flask 0.\*.
-- Removed support for gRPC < 1.39.
-- Removed `last_event_id()` top level API. The last event ID is still returned by `capture_event()`, `capture_exception()` and `capture_message()` but the top level API `sentry_sdk.last_event_id()` has been removed.
-- Removed support for sending events to the `/store` endpoint. Everything is now sent to the `/envelope` endpoint. If you're on SaaS you don't have to worry about this, but if you're running Sentry yourself you'll need version `20.6.0` or higher of self-hosted Sentry.
-- The deprecated `with_locals` configuration option was removed. Use `include_local_variables` instead. See https://docs.sentry.io/platforms/python/configuration/options/#include-local-variables.
-- The deprecated `request_bodies` configuration option was removed. Use `max_request_body_size`. See https://docs.sentry.io/platforms/python/configuration/options/#max-request-body-size.
-- Removed support for `user.segment`. It was also removed from the trace header as well as from the dynamic sampling context.
-- Removed support for the `install` method for custom integrations. Please use `setup_once` instead.
-- Removed `sentry_sdk.tracing.Span.new_span`. Use `sentry_sdk.tracing.Span.start_child` instead.
-- Removed `sentry_sdk.tracing.Transaction.new_span`. Use `sentry_sdk.tracing.Transaction.start_child` instead.
-- Removed `sentry_sdk.utils.Auth.store_api_url`.
-- `sentry_sdk.utils.Auth.get_api_url`'s now accepts a `sentry_sdk.consts.EndpointType` enum instead of a string as its only parameter. We recommend omitting this argument when calling the function, since the parameter's default value is the only possible `sentry_sdk.consts.EndpointType` value. The parameter exists for future compatibility.
-- Removed `tracing_utils_py2.py`. The `start_child_span_decorator` is now in `sentry_sdk.tracing_utils`.
-- Removed the `sentry_sdk.profiler.Scheduler.stop_profiling` method. Any calls to this method can simply be removed, since this was a no-op method.
-
-## Deprecated
-
-- `profiler_mode` and `profiles_sample_rate` have been deprecated as `_experiments` options. Use them as top level options instead:
-  ```python
-  sentry_sdk.init(
-      ...,
-      profiler_mode="thread",
-      profiles_sample_rate=1.0,
-  )
-  ```
-- Deprecated `sentry_sdk.transport.Transport.capture_event`. Please use `sentry_sdk.transport.Transport.capture_envelope`, instead.
-- Passing a function to `sentry_sdk.init`'s `transport` keyword argument has been deprecated. If you wish to provide a custom transport, please pass a `sentry_sdk.transport.Transport` instance or a subclass.
-- The parameter `propagate_hub` in `ThreadingIntegration()` was deprecated and renamed to `propagate_scope`.
-
 ## 1.45.0
 
 This is the final 1.x release for the forseeable future. Development will continue on the 2.x release line. The first 2.x version will be available in the next few weeks.

diff --git a/docs/conf.py b/docs/conf.py
@@ -28,7 +28,7 @@
 copyright = "2019-{}, Sentry Team and Contributors".format(datetime.now().year)
 author = "Sentry Team and Contributors"
 
-release = "2.0.0rc6"
+release = "2.0.0"
 version = ".".join(release.split(".")[:2])  # The short X.Y version.
 
 

diff --git a/sentry_sdk/consts.py b/sentry_sdk/consts.py
@@ -345,4 +345,4 @@ def _get_default_options():
 del _get_default_options
 
 
-VERSION = "2.0.0rc6"
+VERSION = "2.0.0"
diff --git a/setup.py b/setup.py
@@ -21,7 +21,7 @@ def get_file_text(file_name):
 
 setup(
     name="sentry-sdk",
-    version="2.0.0rc6",
+    version="2.0.0",
     author="Sentry Team and Contributors",
     author_email="[email protected]",
     url="https://github.com/getsentry/sentry-python",