Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 1a5e983

Browse files
committedFeb 26, 2024
Updated changelog (and little fix in readme)
1 parent b3fafae commit 1a5e983

File tree

2 files changed

+87
-29
lines changed

2 files changed

+87
-29
lines changed
 

‎CHANGELOG.md

Lines changed: 86 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,93 @@
22

33
## 2.0.0a1
44

5-
### Various fixes & improvements
5+
**Sentry SDK 2.0a1 is alpha software and not yet ready for production!**
6+
7+
Please give it a spin and test it with your project. If you have any questions or feedback please contact us on [Discord](https://discord.gg/Ww9hbqr) in the [#python](https://discord.com/channels/621778831602221064/621783758739079168) channel or create a [GitHub Issue](https://github.com/getsentry/sentry-python/issues) or start a [GitHub Discussion](https://github.com/getsentry/sentry-python/discussions).
8+
9+
Thanks!
10+
11+
### New Features
12+
13+
- 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.
14+
15+
### Changed
16+
17+
- The Pyramid integration will not capture errors that might happen in `authenticated_userid()` in a custom `AuthenticationPolicy` class.
18+
- The method `need_code_loation` of the `MetricsAggregator` was renamed to `need_code_location`.
19+
- The `BackgroundWorker` thread used to process events was renamed from `raven-sentry.BackgroundWorker` to `sentry-sdk.BackgroundWorker`.
20+
- The `reraise` function was moved from `sentry_sdk._compat` to `sentry_sdk.utils`.
21+
- The `_ScopeManager` was moved from `sentry_sdk.hub` to `sentry_sdk.scope`.
22+
- Moved the contents of `tracing_utils_py3.py` to `tracing_utils.py`. The `start_child_span_decorator` is now in `sentry_sdk.tracing_utils`.
23+
- 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.
24+
- `sentry_sdk.tracing_utils.get_current_span()` does now take a `scope` instead of a `hub` as parameter.
25+
- `sentry_sdk.utils._get_contextvars` does not return a tuple with three values, but a tuple with two values. The `copy_context` was removed.
26+
- 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:
27+
Your existing implementation:
28+
```python
29+
transaction = sentry_sdk.transaction(...)
30+
31+
# later in the code execution:
32+
33+
with sentry_sdk.configure_scope() as scope:
34+
scope.set_transaction_name("new-transaction-name")
35+
```
36+
37+
needs to be changed to this:
38+
```python
39+
transaction = sentry_sdk.transaction(...)
40+
41+
# later in the code execution:
42+
43+
scope = sentry_sdk.Scope.get_current_scope()
44+
scope.set_transaction_name("new-transaction-name")
45+
```
46+
- 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.
47+
<details>
48+
<summary><b>Show table</b></summary>
49+
50+
| Class | Abstract methods |
51+
| ------------------------------------- | -------------------------------------- |
52+
| `sentry_sdk.integrations.Integration` | `setup_once` |
53+
| `sentry_sdk.metrics.Metric` | `add`, `serialize_value`, and `weight` |
54+
| `sentry_sdk.profiler.Scheduler` | `setup` and `teardown` |
55+
| `sentry_sdk.transport.Transport` | `capture_envelope` |
56+
57+
</details>
58+
59+
### Removed
60+
61+
- Removed support for Python 2 and Python 3.5. The SDK now requires at least Python 3.6.
62+
- Removed support for Celery 3.\*.
63+
- Removed support for Django 1.8, 1.9, 1.10.
64+
- Removed support for Flask 0.\*.
65+
- 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.
66+
- 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.
67+
- 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.
68+
- 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.
69+
- Removed support for `user.segment`. It was also removed from the trace header as well as from the dynamic sampling context.
70+
- Removed support for the `install` method for custom integrations. Please use `setup_once` instead.
71+
- Removed `sentry_sdk.tracing.Span.new_span`. Use `sentry_sdk.tracing.Span.start_child` instead.
72+
- Removed `sentry_sdk.tracing.Transaction.new_span`. Use `sentry_sdk.tracing.Transaction.start_child` instead.
73+
- Removed `sentry_sdk.utils.Auth.store_api_url`.
74+
- `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.
75+
- Removed `tracing_utils_py2.py`. The `start_child_span_decorator` is now in `sentry_sdk.tracing_utils`.
76+
- 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.
77+
78+
### Deprecated
79+
80+
- `profiler_mode` and `profiles_sample_rate` have been deprecated as `_experiments` options. Use them as top level options instead:
81+
```python
82+
sentry_sdk.init(
83+
...,
84+
profiler_mode="thread",
85+
profiles_sample_rate=1.0,
86+
)
87+
```
88+
- Deprecated `sentry_sdk.transport.Transport.capture_event`. Please use `sentry_sdk.transport.Transport.capture_envelope`, instead.
89+
- 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.
90+
- The parameter `propagate_hub` in `ThreadingIntegration()` was deprecated and renamed to `propagate_scope`.
691

7-
- Temporarily disable tests for alpha release (fa5f50b0) by @antonpirker
8-
- channel link (0594cfa5) by @antonpirker
9-
- Added note to README (cdf4f901) by @antonpirker
10-
- Updated migration guide (ad4ff19c) by @antonpirker
11-
- ref(api): Abstract base classes (#2667) by @szokeasaurusrex
12-
- Scope refactoring (merge Hubs and Scopes) (#2610) by @antonpirker
13-
- docs: Update readme, migration guide (#2754) by @sentrivana
14-
- Remove PY2 (8aa95995) by @sentrivana
15-
- fix(query-source): Fix query source relative filepath (#2717) by @gggritso
16-
- Support clickhouse-driver==0.2.7 (#2752) by @sentrivana
17-
- build(deps): bump checkouts/data-schemas from `6121fd3` to `eb941c2` (#2747) by @dependabot
18-
- Added last_event_id() to the stuff that has been removed. (93f89e00) by @antonpirker
19-
- ref: Use new-style super() (#2744) by @sentrivana
20-
- ref(docs): Tweak migration guide (#2742) by @sentrivana
21-
- fix(metrics): Fix typo (#2735) by @sentrivana
22-
- Deprecate profiler `_experiments` options (#2737) by @sentrivana
23-
- Remove `user.segment` (#2726) by @sentrivana
24-
- ref(transport): Remove compatibility import (#2698) by @sentrivana
25-
- Typo (#2690) by @sentrivana
26-
- Update MIGRATION_GUIDE.md (#2690) by @sentrivana
27-
- Update MIGRATION_GUIDE.md (#2690) by @sentrivana
28-
- ref(api): Remove store endpoint (#2656) by @szokeasaurusrex
29-
- Remove deprecated code (#2666) by @sentrivana
30-
- Auto-enable more integrations (#2671) by @sentrivana
31-
32-
_Plus 17 more_
3392

3493
## 1.40.5
3594

‎README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,10 @@ This is the official Python SDK for [Sentry](http://sentry.io/)
2020

2121
**Sentry SDK 2.0a1** is alpha software and not yet ready for production.
2222

23-
Please give it a spin and test it with your project. If you have any questions or feedback please contact us on [Discord](https://discord.gg/Ww9hbqr) in the [#python](https://discord.com/channels/621778831602221064/621783758739079168) channel or create a [GitHub Issue](https://github.com/getsentry/sentry-python/issues) or start a [GitHub Discussion](https://github.com/getsentry/sentry-python/discussions).
23+
Please give it a spin and test it with your project. If you have any questions or feedback please contact us on [Discord](https://discord.gg/Ww9hbqr) in the [#python](https://discord.com/channels/621778831602221064/621783758739079168) channel or create a [GitHub Issue](https://github.com/getsentry/sentry-python/issues) or start a [GitHub Discussion](https://github.com/getsentry/sentry-python/discussions).
2424

2525
Thanks!
2626

27-
https://discord.com/channels/621778831602221064/621783758739079168
2827

2928
## Getting Started
3029

0 commit comments

Comments
 (0)
Please sign in to comment.