Skip to content

Commit 2642c8a

Browse files
committed
Updated changelog
1 parent cc1dbc0 commit 2642c8a

File tree

1 file changed

+4
-298
lines changed

1 file changed

+4
-298
lines changed

CHANGELOG.md

Lines changed: 4 additions & 298 deletions
Original file line numberDiff line numberDiff line change
@@ -2,194 +2,12 @@
22

33
## 2.0.0
44

5-
- No documented changes.
6-
7-
## 2.0.0rc6
8-
9-
### Various fixes & improvements
10-
11-
- Restore original behavior by always creating a span (#3005) by @antonpirker
12-
- Merge baggage headers (incoming and new created ones) (#3001) by @antonpirker
13-
- Fix duplicate baggage headers in Celery integration introduced in SDK 2.0 (#2993) by @antonpirker
14-
- Make it work with old and new newrelic versions (#2999) by @antonpirker
15-
- docs: Update migration guide wording (#2987) by @colin-sentry
16-
- docs: Tweak migration guide (#2979) by @colin-sentry
17-
- Small updates to migration guide (#2911) by @colin-sentry
18-
- Update CHANGELOG.md (51a906c1) by @sentrivana
19-
- release: 1.45.0 (7570e39a) by @getsentry-bot
20-
21-
## 2.0.0rc5
22-
23-
## New Features
24-
25-
- 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.
26-
- Added new API for custom instrumentation: `new_scope`, `isolation_scope`. See the [Deprecated](#deprecated) section to see how they map to the existing APIs.
27-
28-
## Changed
29-
30-
- The Pyramid integration will not capture errors that might happen in `authenticated_userid()` in a custom `AuthenticationPolicy` class.
31-
- The method `need_code_loation` of the `MetricsAggregator` was renamed to `need_code_location`.
32-
- The `BackgroundWorker` thread used to process events was renamed from `raven-sentry.BackgroundWorker` to `sentry-sdk.BackgroundWorker`.
33-
- The `reraise` function was moved from `sentry_sdk._compat` to `sentry_sdk.utils`.
34-
- The `_ScopeManager` was moved from `sentry_sdk.hub` to `sentry_sdk.scope`.
35-
- Moved the contents of `tracing_utils_py3.py` to `tracing_utils.py`. The `start_child_span_decorator` is now in `sentry_sdk.tracing_utils`.
36-
- 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.
37-
- `sentry_sdk.tracing_utils.add_query_source()`: Removed the `hub` parameter. It is not necessary anymore.
38-
- `sentry_sdk.tracing_utils.record_sql_queries()`: Removed the `hub` parameter. It is not necessary anymore.
39-
- `sentry_sdk.tracing_utils.get_current_span()` does now take a `scope` instead of a `hub` as parameter.
40-
- `sentry_sdk.tracing_utils.should_propagate_trace()` now takes a `Client` instead of a `Hub` as first parameter.
41-
- `sentry_sdk.utils.is_sentry_url()` now takes a `Client` instead of a `Hub` as first parameter.
42-
- `sentry_sdk.utils._get_contextvars` does not return a tuple with three values, but a tuple with two values. The `copy_context` was removed.
43-
- 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:
44-
Your existing implementation:
45-
```python
46-
transaction = sentry_sdk.transaction(...)
47-
48-
# later in the code execution:
49-
50-
with sentry_sdk.configure_scope() as scope:
51-
scope.set_transaction_name("new-transaction-name")
52-
```
53-
54-
needs to be changed to this:
55-
```python
56-
transaction = sentry_sdk.transaction(...)
57-
58-
# later in the code execution:
59-
60-
scope = sentry_sdk.Scope.get_current_scope()
61-
scope.set_transaction_name("new-transaction-name")
62-
```
63-
- 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.
64-
<details>
65-
<summary><b>Show table</b></summary>
66-
67-
| Class | Abstract methods |
68-
| ------------------------------------- | -------------------------------------- |
69-
| `sentry_sdk.integrations.Integration` | `setup_once` |
70-
| `sentry_sdk.metrics.Metric` | `add`, `serialize_value`, and `weight` |
71-
| `sentry_sdk.profiler.Scheduler` | `setup` and `teardown` |
72-
| `sentry_sdk.transport.Transport` | `capture_envelope` |
73-
74-
</details>
75-
76-
## Removed
77-
78-
- Removed support for Python 2 and Python 3.5. The SDK now requires at least Python 3.6.
79-
- Removed support for Celery 3.\*.
80-
- Removed support for Django 1.8, 1.9, 1.10.
81-
- Removed support for Flask 0.\*.
82-
- Removed support for gRPC < 1.39.
83-
- Removed support for Tornado < 6.
84-
- 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.
85-
- 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.
86-
- 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.
87-
- 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.
88-
- Removed support for `user.segment`. It was also removed from the trace header as well as from the dynamic sampling context.
89-
- Removed support for the `install` method for custom integrations. Please use `setup_once` instead.
90-
- Removed `sentry_sdk.tracing.Span.new_span`. Use `sentry_sdk.tracing.Span.start_child` instead.
91-
- Removed `sentry_sdk.tracing.Transaction.new_span`. Use `sentry_sdk.tracing.Transaction.start_child` instead.
92-
- Removed support for creating transactions via `sentry_sdk.tracing.Span(transaction=...)`. To create a transaction, please use `sentry_sdk.tracing.Transaction(name=...)`.
93-
- Removed `sentry_sdk.utils.Auth.store_api_url`.
94-
- `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.
95-
- Removed `tracing_utils_py2.py`. The `start_child_span_decorator` is now in `sentry_sdk.tracing_utils`.
96-
- 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.
97-
98-
## Deprecated
99-
100-
- 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).
101-
102-
Before:
103-
104-
```python
105-
with hub.start_span(...):
106-
# do something
107-
```
108-
109-
After:
110-
111-
```python
112-
import sentry_sdk
113-
114-
with sentry_sdk.start_span(...):
115-
# do something
116-
```
117-
118-
- Hub cloning is deprecated.
119-
120-
Before:
121-
122-
```python
123-
with Hub(Hub.current) as hub:
124-
# do something with the cloned hub
125-
```
126-
127-
After:
128-
129-
```python
130-
import sentry_sdk
131-
132-
with sentry_sdk.isolation_scope() as scope:
133-
# do something with the forked scope
134-
```
135-
136-
- `configure_scope` is deprecated. Use the new isolation scope directly via `Scope.get_isolation_scope()` instead.
137-
138-
Before:
139-
140-
```python
141-
with configure_scope() as scope:
142-
# do something with `scope`
143-
```
144-
145-
After:
146-
147-
```python
148-
from sentry_sdk.scope import Scope
149-
150-
scope = Scope.get_isolation_scope()
151-
# do something with `scope`
152-
```
153-
154-
- `push_scope` is deprecated. Use the new `new_scope` context manager to fork the necessary scopes.
155-
156-
Before:
157-
158-
```python
159-
with push_scope() as scope:
160-
# do something with `scope`
161-
```
162-
163-
After:
164-
165-
```python
166-
import sentry_sdk
167-
168-
with sentry_sdk.new_scope() as scope:
169-
# do something with `scope`
170-
```
171-
172-
- Accessing the client via the hub has been deprecated. Use the top-level `sentry_sdk.get_client()` to get the current client.
173-
- `profiler_mode` and `profiles_sample_rate` have been deprecated as `_experiments` options. Use them as top level options instead:
174-
```python
175-
sentry_sdk.init(
176-
...,
177-
profiler_mode="thread",
178-
profiles_sample_rate=1.0,
179-
)
180-
```
181-
- Deprecated `sentry_sdk.transport.Transport.capture_event`. Please use `sentry_sdk.transport.Transport.capture_envelope`, instead.
182-
- 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.
183-
- The parameter `propagate_hub` in `ThreadingIntegration()` was deprecated and renamed to `propagate_scope`.
184-
185-
## 2.0.0rc4
186-
187-
## New Features
5+
### New Features
1886

1897
- 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.
1908
- Added new API for custom instrumentation: `new_scope`, `isolation_scope`. See the [Deprecated](#deprecated) section to see how they map to the existing APIs.
1919

192-
## Changed
10+
### Changed
19311

19412
- The Pyramid integration will not capture errors that might happen in `authenticated_userid()` in a custom `AuthenticationPolicy` class.
19513
- The method `need_code_loation` of the `MetricsAggregator` was renamed to `need_code_location`.
@@ -237,7 +55,7 @@
23755

23856
</details>
23957

240-
## Removed
58+
### Removed
24159

24260
- Removed support for Python 2 and Python 3.5. The SDK now requires at least Python 3.6.
24361
- Removed support for Celery 3.\*.
@@ -259,7 +77,7 @@
25977
- Removed `tracing_utils_py2.py`. The `start_child_span_decorator` is now in `sentry_sdk.tracing_utils`.
26078
- 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.
26179

262-
## Deprecated
80+
### Deprecated
26381

26482
- 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).
26583

@@ -346,118 +164,6 @@
346164
- 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.
347165
- The parameter `propagate_hub` in `ThreadingIntegration()` was deprecated and renamed to `propagate_scope`.
348166

349-
## 2.0.0rc3
350-
351-
### Various fixes & improvements
352-
353-
- Use new scopes API default integrations. (#2856) by @antonpirker
354-
- Use new scopes API in openai integration (#2853) by @antonpirker
355-
- Use new scopes API in Celery integration. (#2851) by @antonpirker
356-
- Use new scopes API in Django, SQLAlchemy, and asyncpg integration. (#2845) by @antonpirker
357-
- Use new scopes API in Redis (#2854) by @sentrivana
358-
- Use new scopes API in GQL Integration (#2838) by @szokeasaurusrex
359-
- Use new scopes API in LoggingIntegration (#2861, #2855) by @sentrivana
360-
- Use new scopes API in FastAPI integration (#2836) by @szokeasaurusrex
361-
- Use new scopes API in Ariadne (#2850) by @szokeasaurusrex
362-
- Add optional `keep_alive` (#2842) by @sentrivana
363-
- Add support for celery-redbeat cron tasks (#2643) by @kwigley
364-
- AWS Lambda: aws_event can be an empty list (#2849) by @sentrivana
365-
- GQL: Remove problematic tests (#2835) by @szokeasaurusrex
366-
- Moved `should_send_default_pii` into client (#2840) by @antonpirker
367-
- `should_send_default_pii` shortcut (#2844) by @szokeasaurusrex
368-
- Use `scope.should_send_default_pii` in FastAPI integration (#2846) by @szokeasaurusrex
369-
- Patched functions decorator for integrations (#2454) by @szokeasaurusrex
370-
- Small APIdocs improvement (#2828) by @antonpirker
371-
- Bump checkouts/data-schemas from `ed078ed` to `8232f17` (#2832) by @dependabot
372-
- Update CHANGELOG.md (970c5779) by @sentrivana
373-
- Updated migration guide (#2859) by @antonpirker
374-
375-
_Plus 2 more_
376-
377-
## 2.0.0rc2
378-
379-
## New Features
380-
381-
- 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.
382-
383-
## Changed
384-
385-
- The Pyramid integration will not capture errors that might happen in `authenticated_userid()` in a custom `AuthenticationPolicy` class.
386-
- The method `need_code_loation` of the `MetricsAggregator` was renamed to `need_code_location`.
387-
- The `BackgroundWorker` thread used to process events was renamed from `raven-sentry.BackgroundWorker` to `sentry-sdk.BackgroundWorker`.
388-
- The `reraise` function was moved from `sentry_sdk._compat` to `sentry_sdk.utils`.
389-
- The `_ScopeManager` was moved from `sentry_sdk.hub` to `sentry_sdk.scope`.
390-
- Moved the contents of `tracing_utils_py3.py` to `tracing_utils.py`. The `start_child_span_decorator` is now in `sentry_sdk.tracing_utils`.
391-
- 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.
392-
- `sentry_sdk.tracing_utils.get_current_span()` does now take a `scope` instead of a `hub` as parameter.
393-
- `sentry_sdk.utils._get_contextvars` does not return a tuple with three values, but a tuple with two values. The `copy_context` was removed.
394-
- 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:
395-
Your existing implementation:
396-
```python
397-
transaction = sentry_sdk.transaction(...)
398-
399-
# later in the code execution:
400-
401-
with sentry_sdk.configure_scope() as scope:
402-
scope.set_transaction_name("new-transaction-name")
403-
```
404-
405-
needs to be changed to this:
406-
```python
407-
transaction = sentry_sdk.transaction(...)
408-
409-
# later in the code execution:
410-
411-
scope = sentry_sdk.Scope.get_current_scope()
412-
scope.set_transaction_name("new-transaction-name")
413-
```
414-
- 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.
415-
<details>
416-
<summary><b>Show table</b></summary>
417-
418-
| Class | Abstract methods |
419-
| ------------------------------------- | -------------------------------------- |
420-
| `sentry_sdk.integrations.Integration` | `setup_once` |
421-
| `sentry_sdk.metrics.Metric` | `add`, `serialize_value`, and `weight` |
422-
| `sentry_sdk.profiler.Scheduler` | `setup` and `teardown` |
423-
| `sentry_sdk.transport.Transport` | `capture_envelope` |
424-
425-
</details>
426-
427-
## Removed
428-
429-
- Removed support for Python 2 and Python 3.5. The SDK now requires at least Python 3.6.
430-
- Removed support for Celery 3.\*.
431-
- Removed support for Django 1.8, 1.9, 1.10.
432-
- Removed support for Flask 0.\*.
433-
- Removed support for gRPC < 1.39.
434-
- 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.
435-
- 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.
436-
- 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.
437-
- 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.
438-
- Removed support for `user.segment`. It was also removed from the trace header as well as from the dynamic sampling context.
439-
- Removed support for the `install` method for custom integrations. Please use `setup_once` instead.
440-
- Removed `sentry_sdk.tracing.Span.new_span`. Use `sentry_sdk.tracing.Span.start_child` instead.
441-
- Removed `sentry_sdk.tracing.Transaction.new_span`. Use `sentry_sdk.tracing.Transaction.start_child` instead.
442-
- Removed `sentry_sdk.utils.Auth.store_api_url`.
443-
- `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.
444-
- Removed `tracing_utils_py2.py`. The `start_child_span_decorator` is now in `sentry_sdk.tracing_utils`.
445-
- 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.
446-
447-
## Deprecated
448-
449-
- `profiler_mode` and `profiles_sample_rate` have been deprecated as `_experiments` options. Use them as top level options instead:
450-
```python
451-
sentry_sdk.init(
452-
...,
453-
profiler_mode="thread",
454-
profiles_sample_rate=1.0,
455-
)
456-
```
457-
- Deprecated `sentry_sdk.transport.Transport.capture_event`. Please use `sentry_sdk.transport.Transport.capture_envelope`, instead.
458-
- 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.
459-
- The parameter `propagate_hub` in `ThreadingIntegration()` was deprecated and renamed to `propagate_scope`.
460-
461167
## 1.45.0
462168

463169
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.

0 commit comments

Comments
 (0)