Skip to content

Commit aba1db6

Browse files
committed
Updated changelog
1 parent 0100ab8 commit aba1db6

File tree

1 file changed

+48
-39
lines changed

1 file changed

+48
-39
lines changed

CHANGELOG.md

Lines changed: 48 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@
66

77
- Let SentryAsgiMiddleware work with Starlette and FastAPI integrations (#1594) by @antonpirker
88

9+
**Note:** The last version 1.9.6 introduced a breaking change where projects that used Starlette or FastAPI
10+
and had manually setup `SentryAsgiMiddleware` could not start. This versions fixes this behaviour.
11+
With this version if you have a manual `SentryAsgiMiddleware` setup and are using Starlette or FastAPI
12+
everything just works out of the box.
13+
14+
Sorry for any inconveniences the last version might have brought to you.
15+
16+
We can do better and in the future we will do our best to not break your code again.
17+
918
## 1.9.6
1019

1120
### Various fixes & improvements
@@ -66,44 +75,44 @@
6675
### Various fixes & improvements
6776

6877
- feat(starlette): add Starlette integration (#1441) by @sl0thentr0py
69-
70-
**Important:** Remove manual usage of `SentryAsgiMiddleware`! This is now done by the Starlette integration.
71-
72-
Usage:
73-
74-
```python
75-
from starlette.applications import Starlette
76-
77-
from sentry_sdk.integrations.starlette import StarletteIntegration
78-
79-
sentry_sdk.init(
80-
dsn="...",
81-
integrations=[StarletteIntegration()],
82-
)
83-
84-
app = Starlette(debug=True, routes=[...])
85-
```
78+
**Important:** Remove manual usage of `SentryAsgiMiddleware`! This is now done by the Starlette integration.
79+
Usage:
80+
81+
```python
82+
from starlette.applications import Starlette
83+
84+
from sentry_sdk.integrations.starlette import StarletteIntegration
85+
86+
sentry_sdk.init(
87+
dsn="...",
88+
integrations=[StarletteIntegration()],
89+
)
90+
91+
app = Starlette(debug=True, routes=[...])
92+
```
93+
8694
- feat(fastapi): add FastAPI integration (#829) by @antonpirker
87-
88-
**Important:** Remove manual usage of `SentryAsgiMiddleware`! This is now done by the FastAPI integration.
89-
90-
Usage:
91-
92-
```python
93-
from fastapi import FastAPI
94-
95-
from sentry_sdk.integrations.starlette import StarletteIntegration
96-
from sentry_sdk.integrations.fastapi import FastApiIntegration
97-
98-
sentry_sdk.init(
99-
dsn="...",
100-
integrations=[StarletteIntegration(), FastApiIntegration()],
101-
)
102-
103-
app = FastAPI()
104-
```
105-
106-
Yes, you have to add both, the `StarletteIntegration` **AND** the `FastApiIntegration`!
95+
96+
**Important:** Remove manual usage of `SentryAsgiMiddleware`! This is now done by the FastAPI integration.
97+
98+
Usage:
99+
100+
```python
101+
from fastapi import FastAPI
102+
103+
from sentry_sdk.integrations.starlette import StarletteIntegration
104+
from sentry_sdk.integrations.fastapi import FastApiIntegration
105+
106+
sentry_sdk.init(
107+
dsn="...",
108+
integrations=[StarletteIntegration(), FastApiIntegration()],
109+
)
110+
111+
app = FastAPI()
112+
```
113+
114+
Yes, you have to add both, the `StarletteIntegration` **AND** the `FastApiIntegration`!
115+
107116
- fix: avoid sending empty Baggage header (#1507) by @intgr
108117
- fix: properly freeze Baggage object (#1508) by @intgr
109118
- docs: fix simple typo, collecter -> collector (#1505) by @timgates42
@@ -128,7 +137,7 @@
128137
- feat(tracing): Dynamic Sampling Context / Baggage continuation (#1485) by @sl0thentr0py
129138

130139
The SDK now propagates the [W3C Baggage Header](https://www.w3.org/TR/baggage/) from
131-
incoming transactions to outgoing requests.
140+
incoming transactions to outgoing requests.
132141
It also extracts Sentry specific [sampling information](https://develop.sentry.dev/sdk/performance/dynamic-sampling-context/)
133142
and adds it to the transaction headers to enable Dynamic Sampling in the product.
134143

@@ -138,7 +147,7 @@
138147

139148
- Fix Deployment (#1474) by @antonpirker
140149
- Serverless V2 (#1450) by @antonpirker
141-
- Use logging levelno instead of levelname. Levelnames can be overridden (#1449) by @rrauenza
150+
- Use logging levelno instead of levelname. Levelnames can be overridden (#1449) by @rrauenza
142151

143152
## 1.5.12
144153

0 commit comments

Comments
 (0)