Skip to content

Commit

Permalink
Updated changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
antonpirker committed Sep 1, 2022
1 parent 0100ab8 commit aba1db6
Showing 1 changed file with 48 additions and 39 deletions.
87 changes: 48 additions & 39 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@

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

**Note:** The last version 1.9.6 introduced a breaking change where projects that used Starlette or FastAPI
and had manually setup `SentryAsgiMiddleware` could not start. This versions fixes this behaviour.
With this version if you have a manual `SentryAsgiMiddleware` setup and are using Starlette or FastAPI
everything just works out of the box.

Sorry for any inconveniences the last version might have brought to you.

We can do better and in the future we will do our best to not break your code again.

## 1.9.6

### Various fixes & improvements
Expand Down Expand Up @@ -66,44 +75,44 @@
### Various fixes & improvements

- feat(starlette): add Starlette integration (#1441) by @sl0thentr0py

**Important:** Remove manual usage of `SentryAsgiMiddleware`! This is now done by the Starlette integration.

Usage:

```python
from starlette.applications import Starlette

from sentry_sdk.integrations.starlette import StarletteIntegration

sentry_sdk.init(
dsn="...",
integrations=[StarletteIntegration()],
)

app = Starlette(debug=True, routes=[...])
```
**Important:** Remove manual usage of `SentryAsgiMiddleware`! This is now done by the Starlette integration.
Usage:

```python
from starlette.applications import Starlette

from sentry_sdk.integrations.starlette import StarletteIntegration

sentry_sdk.init(
dsn="...",
integrations=[StarletteIntegration()],
)

app = Starlette(debug=True, routes=[...])
```

- feat(fastapi): add FastAPI integration (#829) by @antonpirker

**Important:** Remove manual usage of `SentryAsgiMiddleware`! This is now done by the FastAPI integration.

Usage:

```python
from fastapi import FastAPI

from sentry_sdk.integrations.starlette import StarletteIntegration
from sentry_sdk.integrations.fastapi import FastApiIntegration

sentry_sdk.init(
dsn="...",
integrations=[StarletteIntegration(), FastApiIntegration()],
)

app = FastAPI()
```

Yes, you have to add both, the `StarletteIntegration` **AND** the `FastApiIntegration`!

**Important:** Remove manual usage of `SentryAsgiMiddleware`! This is now done by the FastAPI integration.

Usage:

```python
from fastapi import FastAPI

from sentry_sdk.integrations.starlette import StarletteIntegration
from sentry_sdk.integrations.fastapi import FastApiIntegration

sentry_sdk.init(
dsn="...",
integrations=[StarletteIntegration(), FastApiIntegration()],
)

app = FastAPI()
```

Yes, you have to add both, the `StarletteIntegration` **AND** the `FastApiIntegration`!

- fix: avoid sending empty Baggage header (#1507) by @intgr
- fix: properly freeze Baggage object (#1508) by @intgr
- docs: fix simple typo, collecter -> collector (#1505) by @timgates42
Expand All @@ -128,7 +137,7 @@
- feat(tracing): Dynamic Sampling Context / Baggage continuation (#1485) by @sl0thentr0py

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

Expand All @@ -138,7 +147,7 @@

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

## 1.5.12

Expand Down

0 comments on commit aba1db6

Please sign in to comment.