From aba1db6ad1892529d64b6a59dba8eb74914a23d8 Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Thu, 1 Sep 2022 18:00:25 +0200 Subject: [PATCH] Updated changelog --- CHANGELOG.md | 87 +++++++++++++++++++++++++++++----------------------- 1 file changed, 48 insertions(+), 39 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ac486f1c7c..75b51391cc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 @@ -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 @@ -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. @@ -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