NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI, #217 most downloaded on PyPI
Python client for Sentry (https://sentry.io)
Latest stable
2.75.0
Last release 3 days ago
19 Nov 2026
Ships on a steady schedule
a new release about every 2 weeks
Nearly every release is documented
notes for 60 of the last 60 stable releases
2 versions withdrawn
withdrawn after publishing
8 years old
360 releases · first in 2018
Drag across the ruler to compare, or tap a release to open it.
NEW: Redis integration supports now Sentry Caches module. See https://docs.sentry.io/product/performance/caches/ (#3073) by @antonpirker
cohere testsuite for new release of cohere (#3098) by @antonpirker_sentry_span might be missing (#3096) by @sentrivanaAdd conditional check for delivery_info's existence (#3083) by @cmanallen
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Celery integration now sends additional data to Sentry to enable new features to guage the health of your queues
last_event_id function, which had been removed in 2.0.0get_client typing (#3063) by @szokeasaurusrexFix trace propagation in Celery tasks started by Celery Beat. (#3047) by @antonpirker
fix(quart): Fix Quart integration (#3043) by @szokeasaurusrex
fix(quart): Fix Quart integration (#3043) by @szokeasaurusrex
New integration: Langchain (#2911) by @colin-sentry
Usage: (Langchain is auto enabling, so you do not need to do anything special)
from langchain_openai import ChatOpenAI
import sentry_sdk
sentry_sdk.init(
dsn="...",
enable_tracing=True,
traces_sample_rate=1.0,
)
llm = ChatOpenAI(model="gpt-3.5-turbo-0125", temperature=0)
Check out the LangChain docs for details.
New integration: Anthropic (#2831) by @czyber
Usage: (add the AnthropicIntegration to your sentry_sdk.init() call)
from anthropic import Anthropic
import sentry_sdk
sentry_sdk.init(
dsn="...",
enable_tracing=True,
traces_sample_rate=1.0,
integrations=[AnthropicIntegration()],
)
client = Anthropic()
Check out the Anthropic docs for details.
New integration: Huggingface Hub (#3033) by @colin-sentry
Usage: (Huggingface Hub is auto enabling, so you do not need to do anything special)
import sentry_sdk
from huggingface_hub import InferenceClient
sentry_sdk.init(
dsn="...",
enable_tracing=True,
traces_sample_rate=1.0,
)
client = InferenceClient("some-model")
Check out the Huggingface docs for details. (comming soon!)
fix(huggingface): Reduce API cross-section for huggingface in test (#3042) by @colin-sentry
fix(django): Fix Django ASGI integration on Python 3.12 (#3027) by @bellini666
feat(perf): Add ability to put measurements directly on spans. (#2967) by @colin-sentry
fix(tests): Fix trytond tests (#3031) by @sentrivana
fix(tests): Update pytest-asyncio to fix CI (#3030) by @sentrivana
fix(docs): Link to respective migration guides directly (#3020) by @sentrivana
docs(scope): Add docstring to Scope.set_tags (#2978) by @szokeasaurusrex
test(scope): Fix typos in assert error message (#2978) by @szokeasaurusrex
feat(scope): New set_tags function (#2978) by @szokeasaurusrex
test(scope): Add unit test for Scope.set_tags (#2978) by @szokeasaurusrex
feat(scope): Add set_tags to top-level API (#2978) by @szokeasaurusrex
test(scope): Add unit test for top-level API set_tags (#2978) by @szokeasaurusrex
feat(tests): Parallelize tox (#3025) by @sentrivana
build(deps): Bump checkouts/data-schemas from 4aa14a7 to 4381a97 (#3028) by @dependabot
meta(license): Bump copyright year (#3029) by @szokeasaurusrex
Fix: Do not use convenience decorator (#3022) by @sentrivana
pid for test database name in Django tests (#2998) by @antonpirker1e17eb5 to 4aa14a7 (#2997) by @dependabot(These changes are all backwards-incompatible. Breaking Change (if you are just skimming for that phrase))
This is the first major update in a long time!
We dropped support for some ancient languages and frameworks (Yes, Python 2.7 is no longer supported). Additionally we refactored a big part of the foundation of the SDK (how data inside the SDK is handled).
We hope you like it!
For a shorter version of what you need to do, to upgrade to Sentry SDK 2.0 see: https://docs.sentry.io/platforms/python/migration/1.x-to-2.x
new_scope, isolation_scope. See the Deprecated section to see how they map to the existing APIs.(These changes are all backwards-incompatible. Breaking Change (if you are just skimming for that phrase))
The Pyramid integration will not capture errors that might happen in authenticated_userid() in a custom AuthenticationPolicy class.
The method need_code_loation of the MetricsAggregator was renamed to need_code_location.
The BackgroundWorker thread used to process events was renamed from raven-sentry.BackgroundWorker to sentry-sdk.BackgroundWorker.
The reraise function was moved from sentry_sdk._compat to sentry_sdk.utils.
The _ScopeManager was moved from sentry_sdk.hub to sentry_sdk.scope.
Moved the contents of tracing_utils_py3.py to tracing_utils.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.
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.
sentry_sdk.tracing_utils.add_query_source(): Removed the hub parameter. It is not necessary anymore.
sentry_sdk.tracing_utils.record_sql_queries(): Removed the hub parameter. It is not necessary anymore.
sentry_sdk.tracing_utils.get_current_span() does now take a scope instead of a hub as parameter.
sentry_sdk.tracing_utils.should_propagate_trace() now takes a Client instead of a Hub as first parameter.
sentry_sdk.utils.is_sentry_url() now takes a Client instead of a Hub as first parameter.
sentry_sdk.utils._get_contextvars does not return a tuple with three values, but a tuple with two values. The copy_context was removed.
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:
Your existing implementation:
transaction = sentry_sdk.transaction(...)
# later in the code execution:
with sentry_sdk.configure_scope() as scope:
scope.set_transaction_name("new-transaction-name")
needs to be changed to this:
transaction = sentry_sdk.transaction(...)
# later in the code execution:
scope = sentry_sdk.Scope.get_current_scope()
scope.set_transaction_name("new-transaction-name")
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. <details> <summary><b>Show table</b></summary>
| Class | Abstract methods |
|---|---|
sentry_sdk.integrations.Integration |
setup_once |
sentry_sdk.metrics.Metric |
add, serialize_value, and weight |
sentry_sdk.profiler.Scheduler |
setup and teardown |
sentry_sdk.transport.Transport |
capture_envelope |
</details>
(These changes are all backwards-incompatible. Breaking Change (if you are just skimming for that phrase))
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./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.with_locals configuration option was removed. Use include_local_variables instead. See https://docs.sentry.io/platforms/python/configuration/options/#include-local-variables.request_bodies configuration option was removed. Use max_request_body_size. See https://docs.sentry.io/platforms/python/configuration/options/#max-request-body-size.user.segment. It was also removed from the trace header as well as from the dynamic sampling context.install method for custom integrations. Please use setup_once instead.sentry_sdk.tracing.Span.new_span. Use sentry_sdk.tracing.Span.start_child instead.sentry_sdk.tracing.Transaction.new_span. Use sentry_sdk.tracing.Transaction.start_child instead.sentry_sdk.tracing.Span(transaction=...). To create a transaction, please use sentry_sdk.tracing.Transaction(name=...).sentry_sdk.utils.Auth.store_api_url.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.tracing_utils_py2.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.sentry_sdk.profiler.Scheduler.stop_profiling method. Any calls to this method can simply be removed, since this was a no-op method.Using the Hub directly as well as using hub-based APIs has been deprecated. Where available, use the top-level API instead; otherwise use the scope API or the client API.
Before:
with hub.start_span(...):
# do something
After:
import sentry_sdk
with sentry_sdk.start_span(...):
# do something
Hub cloning is deprecated.
Before:
with Hub(Hub.current) as hub:
# do something with the cloned hub
After:
import sentry_sdk
with sentry_sdk.isolation_scope() as scope:
# do something with the forked scope
configure_scope is deprecated. Use the new isolation scope directly via Scope.get_isolation_scope() instead.
Before:
with configure_scope() as scope:
# do something with `scope`
After:
from sentry_sdk.scope import Scope
scope = Scope.get_isolation_scope()
# do something with `scope`
push_scope is deprecated. Use the new new_scope context manager to fork the necessary scopes.
Before:
with push_scope() as scope:
# do something with `scope`
After:
import sentry_sdk
with sentry_sdk.new_scope() as scope:
# do something with `scope`
Accessing the client via the hub has been deprecated. Use the top-level sentry_sdk.get_client() to get the current client.
profiler_mode and profiles_sample_rate have been deprecated as _experiments options. Use them as top level options instead:
sentry_sdk.init(
...,
profiler_mode="thread",
profiles_sample_rate=1.0,
)
Deprecated sentry_sdk.transport.Transport.capture_event. Please use sentry_sdk.transport.Transport.capture_envelope, instead.
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.
The parameter propagate_hub in ThreadingIntegration() was deprecated and renamed to propagate_scope.
Restore original behavior by always creating a span (#3005) by @antonpirker
Nothing published for this version
Added new API for custom instrumentation: new_scope, isolation_scope. See the Deprecated section to see how they map to the existing APIs.
new_scope, isolation_scope. See the Deprecated section to see how they map to the existing APIs.The Pyramid integration will not capture errors that might happen in authenticated_userid() in a custom AuthenticationPolicy class.
The method need_code_loation of the MetricsAggregator was renamed to need_code_location.
The BackgroundWorker thread used to process events was renamed from raven-sentry.BackgroundWorker to sentry-sdk.BackgroundWorker.
The reraise function was moved from sentry_sdk._compat to sentry_sdk.utils.
The _ScopeManager was moved from sentry_sdk.hub to sentry_sdk.scope.
Moved the contents of tracing_utils_py3.py to tracing_utils.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.
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.
sentry_sdk.tracing_utils.add_query_source(): Removed the hub parameter. It is not necessary anymore.
sentry_sdk.tracing_utils.record_sql_queries(): Removed the hub parameter. It is not necessary anymore.
sentry_sdk.tracing_utils.get_current_span() does now take a scope instead of a hub as parameter.
sentry_sdk.tracing_utils.should_propagate_trace() now takes a Client instead of a Hub as first parameter.
sentry_sdk.utils.is_sentry_url() now takes a Client instead of a Hub as first parameter.
sentry_sdk.utils._get_contextvars does not return a tuple with three values, but a tuple with two values. The copy_context was removed.
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:
Your existing implementation:
transaction = sentry_sdk.transaction(...)
# later in the code execution:
with sentry_sdk.configure_scope() as scope:
scope.set_transaction_name("new-transaction-name")
needs to be changed to this:
transaction = sentry_sdk.transaction(...)
# later in the code execution:
scope = sentry_sdk.Scope.get_current_scope()
scope.set_transaction_name("new-transaction-name")
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. <details> <summary><b>Show table</b></summary>
| Class | Abstract methods |
|---|---|
sentry_sdk.integrations.Integration |
setup_once |
sentry_sdk.metrics.Metric |
add, serialize_value, and weight |
sentry_sdk.profiler.Scheduler |
setup and teardown |
sentry_sdk.transport.Transport |
capture_envelope |
</details>
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./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.with_locals configuration option was removed. Use include_local_variables instead. See https://docs.sentry.io/platforms/python/configuration/options/#include-local-variables.request_bodies configuration option was removed. Use max_request_body_size. See https://docs.sentry.io/platforms/python/configuration/options/#max-request-body-size.user.segment. It was also removed from the trace header as well as from the dynamic sampling context.install method for custom integrations. Please use setup_once instead.sentry_sdk.tracing.Span.new_span. Use sentry_sdk.tracing.Span.start_child instead.sentry_sdk.tracing.Transaction.new_span. Use sentry_sdk.tracing.Transaction.start_child instead.sentry_sdk.tracing.Span(transaction=...). To create a transaction, please use sentry_sdk.tracing.Transaction(name=...).sentry_sdk.utils.Auth.store_api_url.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.tracing_utils_py2.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.sentry_sdk.profiler.Scheduler.stop_profiling method. Any calls to this method can simply be removed, since this was a no-op method.Using the Hub directly as well as using hub-based APIs has been deprecated. Where available, use the top-level API instead; otherwise use the scope API or the client API.
Before:
with hub.start_span(...):
# do something
After:
import sentry_sdk
with sentry_sdk.start_span(...):
# do something
Hub cloning is deprecated.
Before:
with Hub(Hub.current) as hub:
# do something with the cloned hub
After:
import sentry_sdk
with sentry_sdk.isolation_scope() as scope:
# do something with the forked scope
configure_scope is deprecated. Use the new isolation scope directly via Scope.get_isolation_scope() instead.
Before:
with configure_scope() as scope:
# do something with `scope`
After:
from sentry_sdk.scope import Scope
scope = Scope.get_isolation_scope()
# do something with `scope`
push_scope is deprecated. Use the new new_scope context manager to fork the necessary scopes.
Before:
with push_scope() as scope:
# do something with `scope`
After:
import sentry_sdk
with sentry_sdk.new_scope() as scope:
# do something with `scope`
Accessing the client via the hub has been deprecated. Use the top-level sentry_sdk.get_client() to get the current client.
profiler_mode and profiles_sample_rate have been deprecated as _experiments options. Use them as top level options instead:
sentry_sdk.init(
...,
profiler_mode="thread",
profiles_sample_rate=1.0,
)
Deprecated sentry_sdk.transport.Transport.capture_event. Please use sentry_sdk.transport.Transport.capture_envelope, instead.
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.
The parameter propagate_hub in ThreadingIntegration() was deprecated and renamed to propagate_scope.
Use new scopes API default integrations. (#2856) by @antonpirker
keep_alive (#2842) by @sentrivanashould_send_default_pii into client (#2840) by @antonpirkershould_send_default_pii shortcut (#2844) by @szokeasaurusrexscope.should_send_default_pii in FastAPI integration (#2846) by @szokeasaurusrexed078ed to 8232f17 (#2832) by @dependabotPlus 2 more
The deprecated with_locals configuration option was removed. Use include_local_variables instead. See https://docs.sentry.io/platforms/python/configur…
The Pyramid integration will not capture errors that might happen in authenticated_userid() in a custom AuthenticationPolicy class.
The method need_code_loation of the MetricsAggregator was renamed to need_code_location.
The BackgroundWorker thread used to process events was renamed from raven-sentry.BackgroundWorker to sentry-sdk.BackgroundWorker.
The reraise function was moved from sentry_sdk._compat to sentry_sdk.utils.
The _ScopeManager was moved from sentry_sdk.hub to sentry_sdk.scope.
Moved the contents of tracing_utils_py3.py to tracing_utils.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.
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.
sentry_sdk.tracing_utils.get_current_span() does now take a scope instead of a hub as parameter.
sentry_sdk.utils._get_contextvars does not return a tuple with three values, but a tuple with two values. The copy_context was removed.
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:
Your existing implementation:
transaction = sentry_sdk.transaction(...)
# later in the code execution:
with sentry_sdk.configure_scope() as scope:
scope.set_transaction_name("new-transaction-name")
needs to be changed to this:
transaction = sentry_sdk.transaction(...)
# later in the code execution:
scope = sentry_sdk.Scope.get_current_scope()
scope.set_transaction_name("new-transaction-name")
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. <details> <summary><b>Show table</b></summary>
| Class | Abstract methods |
|---|---|
sentry_sdk.integrations.Integration |
setup_once |
sentry_sdk.metrics.Metric |
add, serialize_value, and weight |
sentry_sdk.profiler.Scheduler |
setup and teardown |
sentry_sdk.transport.Transport |
capture_envelope |
</details>
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./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.with_locals configuration option was removed. Use include_local_variables instead. See https://docs.sentry.io/platforms/python/configuration/options/#include-local-variables.request_bodies configuration option was removed. Use max_request_body_size. See https://docs.sentry.io/platforms/python/configuration/options/#max-request-body-size.user.segment. It was also removed from the trace header as well as from the dynamic sampling context.install method for custom integrations. Please use setup_once instead.sentry_sdk.tracing.Span.new_span. Use sentry_sdk.tracing.Span.start_child instead.sentry_sdk.tracing.Transaction.new_span. Use sentry_sdk.tracing.Transaction.start_child instead.sentry_sdk.utils.Auth.store_api_url.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.tracing_utils_py2.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.sentry_sdk.profiler.Scheduler.stop_profiling method. Any calls to this method can simply be removed, since this was a no-op method.profiler_mode and profiles_sample_rate have been deprecated as _experiments options. Use them as top level options instead:sentry_sdk.init(
...,
profiler_mode="thread",
profiles_sample_rate=1.0,
)
sentry_sdk.transport.Transport.capture_event. Please use sentry_sdk.transport.Transport.capture_envelope, instead.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.propagate_hub in ThreadingIntegration() was deprecated and renamed to propagate_scope.The deprecated with_locals configuration option was removed. Use include_local_variables instead. See https://docs.sentry.io/platforms/python/configur…
The Pyramid integration will not capture errors that might happen in authenticated_userid() in a custom AuthenticationPolicy class.
The method need_code_loation of the MetricsAggregator was renamed to need_code_location.
The BackgroundWorker thread used to process events was renamed from raven-sentry.BackgroundWorker to sentry-sdk.BackgroundWorker.
The reraise function was moved from sentry_sdk._compat to sentry_sdk.utils.
The _ScopeManager was moved from sentry_sdk.hub to sentry_sdk.scope.
Moved the contents of tracing_utils_py3.py to tracing_utils.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.
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.
sentry_sdk.tracing_utils.get_current_span() does now take a scope instead of a hub as parameter.
sentry_sdk.utils._get_contextvars does not return a tuple with three values, but a tuple with two values. The copy_context was removed.
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:
Your existing implementation:
transaction = sentry_sdk.transaction(...)
# later in the code execution:
with sentry_sdk.configure_scope() as scope:
scope.set_transaction_name("new-transaction-name")
needs to be changed to this:
transaction = sentry_sdk.transaction(...)
# later in the code execution:
scope = sentry_sdk.Scope.get_current_scope()
scope.set_transaction_name("new-transaction-name")
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. <details> <summary><b>Show table</b></summary>
| Class | Abstract methods |
|---|---|
sentry_sdk.integrations.Integration |
setup_once |
sentry_sdk.metrics.Metric |
add, serialize_value, and weight |
sentry_sdk.profiler.Scheduler |
setup and teardown |
sentry_sdk.transport.Transport |
capture_envelope |
</details>
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./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.with_locals configuration option was removed. Use include_local_variables instead. See https://docs.sentry.io/platforms/python/configuration/options/#include-local-variables.request_bodies configuration option was removed. Use max_request_body_size. See https://docs.sentry.io/platforms/python/configuration/options/#max-request-body-size.user.segment. It was also removed from the trace header as well as from the dynamic sampling context.install method for custom integrations. Please use setup_once instead.sentry_sdk.tracing.Span.new_span. Use sentry_sdk.tracing.Span.start_child instead.sentry_sdk.tracing.Transaction.new_span. Use sentry_sdk.tracing.Transaction.start_child instead.sentry_sdk.utils.Auth.store_api_url.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.tracing_utils_py2.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.sentry_sdk.profiler.Scheduler.stop_profiling method. Any calls to this method can simply be removed, since this was a no-op method.profiler_mode and profiles_sample_rate have been deprecated as _experiments options. Use them as top level options instead:sentry_sdk.init(
...,
profiler_mode="thread",
profiles_sample_rate=1.0,
)
sentry_sdk.transport.Transport.capture_event. Please use sentry_sdk.transport.Transport.capture_envelope, instead.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.propagate_hub in ThreadingIntegration() was deprecated and renamed to propagate_scope.The deprecated with_locals configuration option was removed. Use include_local_variables instead. See https://docs.sentry.io/platforms/python/configur…
Sentry SDK 2.0.0a2 is alpha software and not yet ready for production!
Please give it a spin and test it with your project. If you have any questions or feedback please contact us on Discord in the #python channel or create a GitHub Issue or start a GitHub Discussion.
Thanks!
The Pyramid integration will not capture errors that might happen in authenticated_userid() in a custom AuthenticationPolicy class.
The method need_code_loation of the MetricsAggregator was renamed to need_code_location.
The BackgroundWorker thread used to process events was renamed from raven-sentry.BackgroundWorker to sentry-sdk.BackgroundWorker.
The reraise function was moved from sentry_sdk._compat to sentry_sdk.utils.
The _ScopeManager was moved from sentry_sdk.hub to sentry_sdk.scope.
Moved the contents of tracing_utils_py3.py to tracing_utils.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.
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.
sentry_sdk.tracing_utils.get_current_span() does now take a scope instead of a hub as parameter.
sentry_sdk.utils._get_contextvars does not return a tuple with three values, but a tuple with two values. The copy_context was removed.
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:
Your existing implementation:
transaction = sentry_sdk.transaction(...)
# later in the code execution:
with sentry_sdk.configure_scope() as scope:
scope.set_transaction_name("new-transaction-name")
needs to be changed to this:
transaction = sentry_sdk.transaction(...)
# later in the code execution:
scope = sentry_sdk.Scope.get_current_scope()
scope.set_transaction_name("new-transaction-name")
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. <details> <summary><b>Show table</b></summary>
| Class | Abstract methods |
|---|---|
sentry_sdk.integrations.Integration |
setup_once |
sentry_sdk.metrics.Metric |
add, serialize_value, and weight |
sentry_sdk.profiler.Scheduler |
setup and teardown |
sentry_sdk.transport.Transport |
capture_envelope |
</details>
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./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.with_locals configuration option was removed. Use include_local_variables instead. See https://docs.sentry.io/platforms/python/configuration/options/#include-local-variables.request_bodies configuration option was removed. Use max_request_body_size. See https://docs.sentry.io/platforms/python/configuration/options/#max-request-body-size.user.segment. It was also removed from the trace header as well as from the dynamic sampling context.install method for custom integrations. Please use setup_once instead.sentry_sdk.tracing.Span.new_span. Use sentry_sdk.tracing.Span.start_child instead.sentry_sdk.tracing.Transaction.new_span. Use sentry_sdk.tracing.Transaction.start_child instead.sentry_sdk.utils.Auth.store_api_url.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.tracing_utils_py2.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.sentry_sdk.profiler.Scheduler.stop_profiling method. Any calls to this method can simply be removed, since this was a no-op method.profiler_mode and profiles_sample_rate have been deprecated as _experiments options. Use them as top level options instead:sentry_sdk.init(
...,
profiler_mode="thread",
profiles_sample_rate=1.0,
)
sentry_sdk.transport.Transport.capture_event. Please use sentry_sdk.transport.Transport.capture_envelope, instead.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.propagate_hub in ThreadingIntegration() was deprecated and renamed to propagate_scope.The deprecated with_locals configuration option was removed. Use include_local_variables instead. See https://docs.sentry.io/platforms/python/configur…
Sentry SDK 2.0a1 is alpha software and not yet ready for production!
Please give it a spin and test it with your project. If you have any questions or feedback please contact us on Discord in the #python channel or create a GitHub Issue or start a GitHub Discussion.
Thanks!
The Pyramid integration will not capture errors that might happen in authenticated_userid() in a custom AuthenticationPolicy class.
The method need_code_loation of the MetricsAggregator was renamed to need_code_location.
The BackgroundWorker thread used to process events was renamed from raven-sentry.BackgroundWorker to sentry-sdk.BackgroundWorker.
The reraise function was moved from sentry_sdk._compat to sentry_sdk.utils.
The _ScopeManager was moved from sentry_sdk.hub to sentry_sdk.scope.
Moved the contents of tracing_utils_py3.py to tracing_utils.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.
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.
sentry_sdk.tracing_utils.get_current_span() does now take a scope instead of a hub as parameter.
sentry_sdk.utils._get_contextvars does not return a tuple with three values, but a tuple with two values. The copy_context was removed.
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:
Your existing implementation:
transaction = sentry_sdk.transaction(...)
# later in the code execution:
with sentry_sdk.configure_scope() as scope:
scope.set_transaction_name("new-transaction-name")
needs to be changed to this:
transaction = sentry_sdk.transaction(...)
# later in the code execution:
scope = sentry_sdk.Scope.get_current_scope()
scope.set_transaction_name("new-transaction-name")
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. <details> <summary><b>Show table</b></summary>
| Class | Abstract methods |
|---|---|
sentry_sdk.integrations.Integration |
setup_once |
sentry_sdk.metrics.Metric |
add, serialize_value, and weight |
sentry_sdk.profiler.Scheduler |
setup and teardown |
sentry_sdk.transport.Transport |
capture_envelope |
</details>
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./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.with_locals configuration option was removed. Use include_local_variables instead. See https://docs.sentry.io/platforms/python/configuration/options/#include-local-variables.request_bodies configuration option was removed. Use max_request_body_size. See https://docs.sentry.io/platforms/python/configuration/options/#max-request-body-size.user.segment. It was also removed from the trace header as well as from the dynamic sampling context.install method for custom integrations. Please use setup_once instead.sentry_sdk.tracing.Span.new_span. Use sentry_sdk.tracing.Span.start_child instead.sentry_sdk.tracing.Transaction.new_span. Use sentry_sdk.tracing.Transaction.start_child instead.sentry_sdk.utils.Auth.store_api_url.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.tracing_utils_py2.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.sentry_sdk.profiler.Scheduler.stop_profiling method. Any calls to this method can simply be removed, since this was a no-op method.profiler_mode and profiles_sample_rate have been deprecated as _experiments options. Use them as top level options instead:sentry_sdk.init(
...,
profiler_mode="thread",
profiles_sample_rate=1.0,
)
sentry_sdk.transport.Transport.capture_event. Please use sentry_sdk.transport.Transport.capture_envelope, instead.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.propagate_hub in ThreadingIntegration() was deprecated and renamed to propagate_scope.This is a security backport release.
This is a security backport release.
Don't send full env to subprocess (892dd800) by @kmichel-aiven
See also https://github.com/getsentry/sentry-python/security/advisories/GHSA-g92j-qhmh-64v2
Remove deprecated typing imports in crons (#2945) by @szokeasaurusrex
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.
Allow to upsert monitors (#2929) by @sentrivana
It's now possible to provide monitor_config to the monitor decorator/context manager directly:
from sentry_sdk.crons import monitor
# All keys except `schedule` are optional
monitor_config = {
"schedule": {"type": "crontab", "value": "0 0 * * *"},
"timezone": "Europe/Vienna",
"checkin_margin": 10,
"max_runtime": 10,
"failure_issue_threshold": 5,
"recovery_threshold": 5,
}
@monitor(monitor_slug='<monitor-slug>', monitor_config=monitor_config)
def tell_the_world():
print('My scheduled task...')
Check out the cron docs for details.
Add Django signals_denylist to filter signals that are attached to by signals_spans (#2758) by @lieryan
If you want to exclude some Django signals from performance tracking, you can use the new signals_denylist Django option:
import django.db.models.signals
import sentry_sdk
sentry_sdk.init(
...
integrations=[
DjangoIntegration(
...
signals_denylist=[
django.db.models.signals.pre_init,
django.db.models.signals.post_init,
],
),
],
)
increment for metrics (#2588) by @mitsuhiko
increment and incr are equivalent, so you can pick whichever you like more.
Add value, unit to before_emit_metric (#2958) by @sentrivana
If you add a custom before_emit_metric, it'll now accept 4 arguments (the key, value, unit and tags) instead of just key and tags.
def before_emit(key, value, unit, tags):
if key == "removed-metric":
return False
tags["extra"] = "foo"
del tags["release"]
return True
sentry_sdk.init(
...
_experiments={
"before_emit_metric": before_emit,
}
)
Remove experimental metric summary options (#2957) by @sentrivana
The _experiments options metrics_summary_sample_rate and should_summarize_metric have been removed.
New normalization rules for metric keys, names, units, tags (#2946) by @sentrivana
Change data_category from statsd to metric_bucket (#2954) by @cleptric
Accessing __mro__ might throw a ValueError (#2952) by @sentrivana
Suppress prompt spawned by subprocess when using pythonw (#2936) by @collinbanko
Handle None in GraphQL query #2715 (#2762) by @czyber
Do not send "quiet" Sanic exceptions to Sentry (#2821) by @hamedsh
Implement metric_bucket rate limits (#2933) by @cleptric
Fix type hints for monitor decorator (#2944) by @szokeasaurusrex
Remove deprecated typing imports in crons (#2945) by @szokeasaurusrex
Make monitor_config a TypedDict (#2931) by @sentrivana
Add devenv-requirements.txt and update env setup instructions (#2761) by @arr-ee
Bump types-protobuf from 4.24.0.20240311 to 4.24.0.20240408 (#2941) by @dependabot
Disable Codecov check run annotations (#2537) by @eliatcodecov
Make monitor async friendly (#2912) by @sentrivana
Make monitor async friendly (#2912) by @sentrivana
You can now decorate your async functions with the monitor
decorator and they will correctly report their duration
and completion status.
Fixed Event | None runtime TypeError (#2928) by @szokeasaurusrex
ref: Define types at runtime (#2914) by @szokeasaurusrex
Add optional keep_alive (#2842) by @sentrivana
Add optional keep_alive (#2842) by @sentrivana
If you're experiencing frequent network issues between the SDK and Sentry, you can try turning on TCP keep-alive:
import sentry_sdk
sentry_sdk.init(
# ...your usual settings...
keep_alive=True,
)
Add support for Celery Redbeat cron tasks (#2643) by @kwigley
The SDK now supports the Redbeat scheduler in addition to the default Celery Beat scheduler for auto instrumenting crons. See the docs for more information about how to set this up.
aws_event can be an empty list (#2849) by @sentrivana
Re-export Event in types.py (#2829) by @szokeasaurusrex
Small API docs improvement (#2828) by @antonpirker
Fixed OpenAI tests (#2834) by @antonpirker
Bump checkouts/data-schemas from ed078ed to 8232f17 (#2832) by @dependabot
New integration: OpenAI integration (#2791) by @colin-sentry
New integration: OpenAI integration (#2791) by @colin-sentry
We added an integration for OpenAI to capture errors and also performance data when using the OpenAI Python SDK.
Useage:
This integrations is auto-enabling, so if you have the openai package in your project it will be enabled. Just initialize Sentry before you create your OpenAI client.
from openai import OpenAI
import sentry_sdk
sentry_sdk.init(
dsn="___PUBLIC_DSN___",
enable_tracing=True,
traces_sample_rate=1.0,
)
client = OpenAI()
For more information, see the documentation for OpenAI integration.
Discard open OpenTelemetry spans after 10 minutes (#2801) by @antonpirker
Propagate sentry-trace and baggage headers to Huey tasks (#2792) by @cnschn
Added Event type (#2753) by @szokeasaurusrex
Improve scrub_dict typing (#2768) by @szokeasaurusrex
Dependencies: bump types-protobuf from 4.24.0.20240302 to 4.24.0.20240311 (#2797) by @dependabot
Add recursive scrubbing to EventScrubber (#2755) by @Cheapshot003
Add recursive scrubbing to EventScrubber (#2755) by @Cheapshot003
By default, the EventScrubber will not search your events for potential
PII recursively. With this release, you can enable this behavior with:
import sentry_sdk
from sentry_sdk.scrubber import EventScrubber
sentry_sdk.init(
# ...your usual settings...
event_scrubber=EventScrubber(recursive=True),
)
Expose socket_options (#2786) by @sentrivana
If the SDK is experiencing connection issues (connection resets, server
closing connection without response, etc.) while sending events to Sentry,
tweaking the default urllib3 socket options to the following can help:
import socket
from urllib3.connection import HTTPConnection
import sentry_sdk
sentry_sdk.init(
# ...your usual settings...
socket_options=HTTPConnection.default_socket_options + [
(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),
# note: skip the following line if you're on MacOS since TCP_KEEPIDLE doesn't exist there
(socket.SOL_TCP, socket.TCP_KEEPIDLE, 45),
(socket.SOL_TCP, socket.TCP_KEEPINTVL, 10),
(socket.SOL_TCP, socket.TCP_KEEPCNT, 6),
],
)
Allow to configure merge target for releases (#2777) by @sentrivana
Allow empty character in metric tags values (#2775) by @viglia
Replace invalid tag values with an empty string instead of _ (#2773) by @markushi
Add documentation comment to scrub_list (#2769) by @szokeasaurusrex
Fixed regex to parse version in lambda package file (#2767) by @antonpirker
xfail broken AWS Lambda tests for now (#2794) by @sentrivana
Removed print statements because it messes with the tests (#2789) by @antonpirker
Bump types-protobuf from 4.24.0.20240129 to 4.24.0.20240302 (#2782) by @dependabot
Bump checkouts/data-schemas from eb941c2 to ed078ed (#2781) by @dependabot
Fix compatibility with greenlet/gevent (#2756) by @sentrivana
greenlet/gevent (#2756) by @sentrivanaclickhouse-driver==0.2.7 (#2752) by @sentrivanacheckouts/data-schemas from 6121fd3 to eb941c2 (#2747) by @dependabotDeprecate last_event_id(). (#2749) by @antonpirker
Deprecate last_event_id(). (#2749) by @antonpirker
Warn if uWSGI is set up without proper thread support (#2738) by @sentrivana
uWSGI has to be run in threaded mode for the SDK to run properly. If this is not the case, the consequences could range from features not working unexpectedly to uWSGI workers crashing.
Please make sure to run uWSGI with both --enable-threads and --py-call-uwsgi-fork-hooks.
parsed_url can be None (#2734) by @sentrivana
Python 3.7 is not supported anymore by Lambda, so removed it and added 3.12 (#2729) by @antonpirker
Only start metrics flusher thread on demand (#2727) by @sentrivana
aa7058c to 6121fd3 (#2724) by @dependabotTurn off metrics for uWSGI (#2720) by @sentrivana
test: Fix pytest error (#2712) by @szokeasaurusrex
pytest error (#2712) by @szokeasaurusrexFix uWSGI workers hanging (#2694) by @sentrivana
gevent (#2694) by @sentrivanaengine.url being None (#2708) by @sentrivanasentry_sdk.utils._generate_installed_modules (#2703) by @GlenWalkercodecov/codecov-action from 3 to 4 (#2706) by @dependabotactions/cache from 3 to 4 (#2661) by @dependabotactions/checkout from 3.1.0 to 4.1.1 (#2561) by @dependabotgithub/codeql-action from 2 to 3 (#2603) by @dependabotactions/setup-python from 4 to 5 (#2577) by @dependabotEnable metrics related settings by default (#2685) by @iambriccardo
UnicodeDecodeError on Python 2 (#2657) by @sentrivanablack==24.1.0 (#2680) by @sentrivanasentry_sdk.trace type hints (#2633) by @szokeasaurusrexcheckouts/data-schemas from e9f7d58 to aa7058c (#2639) by @dependabotFix timestamp in transaction created by OTel (#2627) by @antonpirker
TypeError for static and class methods (#2559) by @szokeasaurusrexctx in Arq integration (#2600) by @ivanovartdata_category from check_in to monitor (#2598) by @sentrivanaFix psycopg2 detection in the Django integration (#2593) by @sentrivana
error_sampler function (#2511) by @antonpirkeraiohttp (#2590) by @antonpirkerAdd support for cluster clients from Redis SDK (#2394) by @md384
TypeError with no-argument apply_async (#2575) by @szokeasaurusrexos.path.devnull access issues (#2579) by @sentrivanacode.filepath frame picking logic (#2568) by @sentrivanaOnly add trace context to checkins and do not run event_processors for checkins (#2536) by @antonpirker
event_processors for checkins (#2536) by @antonpirkerjinja2 for generating CI yamls (#2534) by @sentrivanaFix NameError on parse_version with eventlet (#2532) by @sentrivana
NameError on parse_version with eventlet (#2532) by @sentrivana68def1e to e9f7d58 (#2501) by @dependabotMove installed modules code to utils (#2429) by @sentrivana
Move installed modules code to utils (#2429) by @sentrivana
Note: We moved the internal function _get_installed_modules from sentry_sdk.integrations.modules to sentry_sdk.utils.
So if you use this function you have to update your imports
Add code locations for metrics (#2526) by @jan-auer
Add query source to DB spans (#2521) by @antonpirker
Send events to Spotlight sidecar (#2524) by @HazAT
Run integration tests with newest pytest (#2518) by @sentrivana
Bring tests up to date (#2512) by @sentrivana
Fix: Prevent global var from being discarded at shutdown (#2530) by @antonpirker
Fix: Scope transaction source not being updated in scope.span setter (#2519) by @sl0thentr0py
Django: Support Django 5.0 (#2490) by @sentrivana
RedisIntegration is disabled, unless redis is installed (#2504) by @szokeasaurusrexPython 3.12: Replace deprecated datetime functions (#2502) by @sentrivana
Updated gRPC integration: Asyncio interceptors and easier setup (#2369) by @fdellekart
Our gRPC integration now instruments incoming unary-unary grpc requests and outgoing unary-unary, unary-stream grpc requests using grpcio channels. Everything works now for sync and async code.
Before this release you had to add Sentry interceptors by hand to your gRPC code, now the only thing you need to do is adding the GRPCIntegration to you sentry_sdk_init() call. (See documentation for more information):
import sentry_sdk
from sentry_sdk.integrations.grpc import GRPCIntegration
sentry_sdk.init(
dsn="___PUBLIC_DSN___",
enable_tracing=True,
integrations=[
GRPCIntegration(),
],
)
The old way still works, but we strongly encourage you to update your code to the way described above.
Python 3.12: Replace deprecated datetime functions (#2502) by @sentrivana
Metrics: Unify datetime format (#2409) by @mitsuhiko
Celery: Set correct data in check_ins (#2500) by @antonpirker
Celery: Read timezone for Crons monitors from celery_schedule if existing (#2497) by @antonpirker
Django: Removing redundant code in Django tests (#2491) by @vagi8
Django: Make reading the request body work in Django ASGI apps. (#2495) by @antonpirker
FastAPI: Use wraps on fastapi request call wrapper (#2476) by @nkaras
Fix: Probe for psycopg2 and psycopg3 parameters function. (#2492) by @antonpirker
Fix: Remove unnecessary TYPE_CHECKING alias (#2467) by @rafrafek
Added Python 3.12 support (#2471, #2483)
connection_kwargs in patch_redis_client (#2482) by @szokeasaurusrexMake parse_version work in utils.py itself. (#2474) by @antonpirker
New: Added error_sampler option (#2456) by @szokeasaurusrex
error_sampler option (#2456) by @szokeasaurusrexdebug option also configurable via environment (#2450) by @antonpirkerget_dsn_parameters is an actual function (#2441) by @sentrivanaredis database spans (#2398) by @antonpirkerpath patterns (#2452) by @sentrivanaRemove utcnow, utcfromtimestamp deprecated in Python 3.12 (#2415) by @rmad17
New: Error monitoring for some of the most popular Python GraphQL libraries:
Add GQL GraphQL integration (#2368) by @szokeasaurusrex
Usage:
import sentry_sdk
from sentry_sdk.integrations.gql import GQLIntegration
sentry_sdk.init(
dsn='___PUBLIC_DSN___',
integrations=[
GQLIntegration(),
],
)
Add Graphene GraphQL error integration (#2389) by @sentrivana
Usage:
import sentry_sdk
from sentry_sdk.integrations.graphene import GrapheneIntegration
sentry_sdk.init(
dsn='___PUBLIC_DSN___',
integrations=[
GrapheneIntegration(),
],
)
Add Strawberry GraphQL error & tracing integration (#2393) by @sentrivana
Usage:
import sentry_sdk
from sentry_sdk.integrations.strawberry import StrawberryIntegration
sentry_sdk.init(
dsn='___PUBLIC_DSN___',
integrations=[
# make sure to set async_execution to False if you're executing
# GraphQL queries synchronously
StrawberryIntegration(async_execution=True),
],
traces_sample_rate=1.0,
)
Add Ariadne GraphQL error integration (#2387) by @sentrivana
Usage:
import sentry_sdk
from sentry_sdk.integrations.ariadne import AriadneIntegration
sentry_sdk.init(
dsn='___PUBLIC_DSN___',
integrations=[
AriadneIntegration(),
],
)
Capture multiple named groups again (#2432) by @sentrivana
Don't fail when upstream scheme is unusual (#2371) by @vanschelven
Support new RQ version (#2405) by @antonpirker
Remove utcnow, utcfromtimestamp deprecated in Python 3.12 (#2415) by @rmad17
Add trace to __all__ in top-level __init__.py (#2401) by @lobsterkatie
Move minimetrics code to the SDK (#2385) by @mitsuhiko
Add configurable compression levels (#2382) by @mitsuhiko
Shift flushing by up to a rollup window (#2396) by @mitsuhiko
Make a consistent noop flush behavior (#2428) by @mitsuhiko
Stronger recursion protection (#2426) by @mitsuhiko
Remove OpenTelemetryIntegration from __init__.py (#2379) by @sentrivana
Update API docs (#2397) by @antonpirker
Pin some test requirements because new majors break our tests (#2404) by @antonpirker
Run more requests, celery, falcon tests (#2414) by @sentrivana
Move importorskips in tests to __init__.py files (#2412) by @sentrivana
Fix mypy errors (#2433) by @sentrivana
Fix pre-commit issues (#2424) by @bukzor-sentryio
Update CONTRIBUTING.md (#2411) by @sentrivana
Bump sphinx from 7.2.5 to 7.2.6 (#2378) by @dependabot
[Experimental] Add explain plan to DB spans (#2315) by @antonpirker
Fix deprecated version attribute (#2338) by @vagi8
New: Add integration for clickhouse-driver (#2167) by @mimre25
For more information, see the documentation for clickhouse-driver for more information.
Usage:
import sentry_sdk
from sentry_sdk.integrations.clickhouse_driver import ClickhouseDriverIntegration
sentry_sdk.init(
dsn='___PUBLIC_DSN___',
integrations=[
ClickhouseDriverIntegration(),
],
)
New: Add integration for asyncpg (#2314) by @mimre25
For more information, see the documentation for asyncpg for more information.
Usage:
import sentry_sdk
from sentry_sdk.integrations.asyncpg import AsyncPGIntegration
sentry_sdk.init(
dsn='___PUBLIC_DSN___',
integrations=[
AsyncPGIntegration(),
],
)
New: Allow to override propagate_traces in Celery per task (#2331) by @jan-auer
For more information, see the documentation for Celery for more information.
Usage:
import sentry_sdk
from sentry_sdk.integrations.celery import CeleryIntegration
# Enable global distributed traces (this is the default, just to be explicit.)
sentry_sdk.init(
dsn='___PUBLIC_DSN___',
integrations=[
CeleryIntegration(propagate_traces=True),
],
)
...
# This will NOT propagate the trace. (The task will start its own trace):
my_task_b.apply_async(
args=("some_parameter", ),
headers={"sentry-propagate-traces": False},
)
Prevent Falcon integration from breaking ASGI apps (#2359) by @szokeasaurusrex
Backpressure: only downsample a max of 10 times (#2347) by @sl0thentr0py
Made NoOpSpan compatible to Transactions. (#2364) by @antonpirker
Cleanup ASGI integration (#2335) by @antonpirker
Pin anyio in tests (dep of httpx), because new major 4.0.0 breaks tests. (#2336) by @antonpirker
Added link to backpressure section in docs. (#2354) by @antonpirker
Add .vscode to .gitignore (#2317) by @shoaib-mohd
Documenting Spans and Transactions (#2358) by @antonpirker
Fix in profiler: do not call getcwd from module root (#2329) by @Zylphrex
Fix deprecated version attribute (#2338) by @vagi8
Fix transaction name in Starlette and FastAPI (#2341) by @antonpirker
Fix tests using Postgres (#2362) by @antonpirker
build(deps): Updated linting tooling (#2350) by @antonpirker
build(deps): bump sphinx from 7.2.4 to 7.2.5 (#2344) by @dependabot
build(deps): bump actions/checkout from 2 to 4 (#2352) by @dependabot
build(deps): bump checkouts/data-schemas from ebc77d3 to 68def1e (#2351) by @dependabot
Officially support Python 3.11 (#2300) by @sentrivana
Officially support Python 3.11 (#2300) by @sentrivana
Context manager monitor (#2290) by @szokeasaurusrex
Set response status code in transaction response context. (#2312) by @antonpirker
Add missing context kwarg to _sentry_task_factory (#2267) by @JohnnyDeuss
In Postgres take the connection params from the connection (#2308) by @antonpirker
Experimental: Allow using OTel for performance instrumentation (#2272) by @sentrivana
This release includes experimental support for replacing Sentry's default performance monitoring solution with one powered by OpenTelemetry without having to do any manual setup.
Try it out by installing pip install sentry-sdk[opentelemetry-experimental] and
then initializing the SDK with:
sentry_sdk.init(
# ...your usual options...
_experiments={"otel_powered_performance": True},
)
This enables OpenTelemetry performance monitoring support for some of the most popular frameworks and libraries (Flask, Django, FastAPI, requests...).
We're looking forward to your feedback! Please let us know about your experience in this discussion: https://github.com/getsentry/sentry/discussions/55023
Important note: Please note that this feature is experimental and in a proof-of-concept stage and is not meant for production use. It may be changed or removed at any point.
Enable backpressure handling by default (#2298) by @sl0thentr0py
The SDK now dynamically downsamples transactions to reduce backpressure in high
throughput systems. It starts a new Monitor thread to perform some health checks
which decide to downsample (halved each time) in 10 second intervals till the system
is healthy again.
To disable this behavior, use:
sentry_sdk.init(
# ...your usual options...
enable_backpressure_handling=False,
)
If your system serves heavy load, please let us know how this feature works for you! Check out the documentation for more information.
Stop recording spans for internal web requests to Sentry (#2297) by @szokeasaurusrex
Add test for ThreadPoolExecutor (#2259) by @gggritso
Add docstrings for Scope.update_from_* (#2311) by @sentrivana
Moved is_sentry_url to utils (#2304) by @szokeasaurusrex
Fix: arq attribute error on settings, support worker args (#2260) by @rossmacarthur
Fix: Exceptions include detail property for their value (#2193) by @nicolassanmar
build(deps): bump mypy from 1.4.1 to 1.5.1 (#2319) by @dependabot
build(deps): bump sphinx from 7.1.2 to 7.2.4 (#2322) by @dependabot
build(deps): bump sphinx from 7.0.1 to 7.1.2 (#2296) by @dependabot
build(deps): bump checkouts/data-schemas from 1b85152 to ebc77d3 (#2254) by @dependabot
Revert GraphQL integration (#2287) by @sentrivana
Fix GraphQL integration swallowing responses (#2286) by @sentrivana
Capture GraphQL client errors (#2243) by @sentrivana
/graphql endpoint and the response contains an error. You can opt out of this by providing capture_graphql_errors=False to the HTTP client integration.request_bodies to max_request_body_size (#2247) by @mgalignianasample_rate (#2279) by @szokeasaurusrexdb.system to remaining Redis spans (#2271) by @AbhiPrasadRedis: Add support for redis.asyncio (#1933) by @Zhenay
sentry-trace and baggage) to HTTP requests to Sentry (#2240) by @antonpirkersentry-trace header multiple times (#2235) by @antonpirkerAdd support for cron jobs in ARQ integration (#2088) by @lewazo
Add Starlette/FastAPI template tag for adding Sentry tracing information (#2225) by @antonpirker
{{ sentry_trace_meta }} to your Starlette/FastAPI Jinja2 templates we will include Sentry trace information as a meta tag in the rendered HTML to allow your frontend to pick up and continue the trace started in the backend.None for trace_configs in aiohttp (#2230) by @Harmon758Support for SQLAlchemy 2.0 (#2200) by @antonpirker
Support for SQLAlchemy 2.0 (#2200) by @antonpirker
Add instrumentation of aiohttp client requests (#1761) by @md384
Add Django template tag for adding Sentry tracing information (#2222) by @antonpirker
{{ sentry_trace_meta }} to your Django templates we will include Sentry trace information as a meta tag in the rendered HTML to allow your frontend to pick up and continue the trace started in the backend.Update Flask HTML meta helper (#2203) by @antonpirker
Take trace ID always from propagation context (#2209) by @antonpirker
Fix trace context in event payload (#2205) by @antonpirker
Use new top level API in trace_propagation_meta (#2202) by @antonpirker
Do not overwrite existing baggage on outgoing requests (#2191, #2214) by @sentrivana
Set the transaction/span status from an OTel span (#2115) by @daniil-konovalenko
Fix propagation of OTel NonRecordingSpan (#2187) by @hartungstenio
Fix TaskLockedException handling in Huey integration (#2206) by @Zhenay
Add message format configuration arguments to Loguru integration (#2208) by @Gwill
Profiling: Add client reports for profiles (#2207) by @Zylphrex
CI: Fix CI (#2220) by @antonpirker
Dependencies: Bump checkouts/data-schemas from 7fdde87 to 1b85152 (#2218) by @dependabot
Dependencies: Bump mypy from 1.3.0 to 1.4.1 (#2194) by @dependabot
Docs: Change API doc theme (#2210) by @sentrivana
Docs: Allow (some) autocompletion for top-level API (#2213) by @sentrivana
Docs: Revert autocomplete hack (#2224) by @sentrivana
Tracing without performance (#2136) by @antonpirker
parse_url calls in capture_internal_exceptions (#2162) by @sentrivana0ed3357 to 7fdde87 (#2165) by @dependabotCollections of improvements to our Django integration.
Collections of improvements to our Django integration.
By: @mgaligniana (#1773)
Fix parse_url (#2161) by @sentrivana and @antonpirker
Our URL sanitization used in multiple integrations broke with the recent Python security update. If you started seeing ValueErrors with "'Filtered' does not appear to be an IPv4 or IPv6 address", this release fixes that. See the original issue for more context.
Better version parsing in integrations (#2152) by @antonpirker
We now properly support all integration versions that conform to PEP 440. This replaces our naïve version parsing that wouldn't accept versions such as 2.0.0rc1 or 2.0.5.post1.
Align HTTP status code as span data field http.response.status_code (#2113) by @antonpirker
Do not encode cached value to determine size (#2143) by @sentrivana
Fix using unittest.mock whenever available (#1926) by @mgorny
Fix 2.7 common tests (#2145) by @sentrivana
Bump actions/stale from 6 to 8 (#1978) by @dependabot
Bump black from 22.12.0 to 23.3.0 (#1984) by @dependabot
Bump mypy from 1.2.0 to 1.3.0 (#2110) by @dependabot
Bump sphinx from 5.3.0 to 7.0.1 (#2112) by @dependabot
Support urllib3>=2.0.0 (#2148) by @asottile-sentry
Support urllib3>=2.0.0 (#2148) by @asottile-sentry
We're now supporting urllib3's new major version, 2.0.0. If you encounter issues (e.g. some of your dependencies not supporting the new urllib3 version yet) you might consider pinning the urllib3 version to <2.0.0 manually in your project. Check out the the urllib3 migration guide for details.
Auto-retry tests on failure (#2134) by @sentrivana
Correct importlib.metadata check in test_modules (#2149) by @asottile-sentry
Fix distribution name normalization (PEP-0503) (#2144) by @rominf
Fix functions_to_trace typing (#2141) by @rcmarron
New: Celery Beat exclude tasks option (#2130) by @antonpirker
New: Celery Beat exclude tasks option (#2130) by @antonpirker
You can exclude Celery Beat tasks from being auto-instrumented. To do this, add a list of tasks you want to exclude as option exclude_beat_tasks when creating CeleryIntegration. The list can contain simple strings with the full task name, as specified in the Celery Beat schedule, or regular expressions to match multiple tasks.
For more information, see the documentation for Crons for more information.
Usage:
exclude_beat_tasks = [
"some-task-a",
"payment-check-.*",
]
sentry_sdk.init(
dsn='___PUBLIC_DSN___',
integrations=[
CeleryIntegration(
monitor_beat_tasks=True,
exclude_beat_tasks=exclude_beat_tasks,
),
],
)
In this example the task some-task-a and all tasks with a name starting with payment-check- will be ignored.
New: Add support for ExceptionGroups (#2025) by @antonpirker
Note: If running Self-Hosted Sentry, you should wait to adopt this SDK update until after updating to the 23.6.0 (est. June 2023) release of Sentry. Updating early will not break anything, but you will not get the full benefit of the Exception Groups improvements to issue grouping that were added to the Sentry backend.
Prefer importlib.metadata over pkg_resources if available (#2081) by @sentrivana
Work with a copy of request, vars in the event (#2125) by @sentrivana
Pinned version of dependency that broke the build (#2133) by @antonpirker
Disable Django Cache spans by default. (#2120) by @antonpirker
New: Add loguru integration (#1994) by @PerchunPak
New: Add loguru integration (#1994) by @PerchunPak
Check the documentation for more information.
Usage:
from loguru import logger
import sentry_sdk
from sentry_sdk.integrations.loguru import LoguruIntegration
sentry_sdk.init(
dsn="___PUBLIC_DSN___",
integrations=[
LoguruIntegration(),
],
)
logger.debug("I am ignored")
logger.info("I am a breadcrumb")
logger.error("I am an event", extra=dict(bar=43))
logger.exception("An exception happened")
"I am an event" will be created."I am a breadcrumb" will be attached as a breadcrumb to that event.bar will end up in the extra attributes of that event."An exception happened" will send the current exception from sys.exc_info() with the stack trace to Sentry. If there's no exception, the current stack will be attached."I am ignored" will not be captured by Sentry. To capture it, set level to DEBUG or lower in LoguruIntegration.Do not truncate request body if request_bodies is "always" (#2092) by @sentrivana
Fixed Celery headers for Beat auto-instrumentation (#2102) by @antonpirker
Add db.operation to Redis and MongoDB spans (#2089) by @antonpirker
Make sure we're importing redis the library (#2106) by @sentrivana
Add include_source_context option (#2020) by @farhat-nawaz and @sentrivana
Import Markup from markupsafe (#2047) by @rco-ableton
Fix __qualname__ missing attribute in asyncio integration (#2105) by @sl0thentr0py
Remove relay extension from AWS Layer (#2068) by @sl0thentr0py
Add a note about pip freeze to the bug template (#2103) by @sentrivana
Fix: Django caching spans when using keyword arguments (#2086) by @antonpirker
Fix: Handle a list of keys (not just a single key) in Django cache spans (#2082) by @antonpirker
Add cache.hit and cache.item_size to Django (#2057) by @antonpirker
Add cache.hit and cache.item_size to Django (#2057) by @antonpirker
Note: This will add spans for all requests to the caches configured in Django. This will probably add some overhead to your server an also add multiple spans to your performance waterfall diagrams. If you do not want this, you can disable this feature in the DjangoIntegration:
sentry_sdk.init(
dsn="...",
integrations=[
DjangoIntegration(cache_spans=False),
]
)
Use http.method instead of method (#2054) by @AbhiPrasad
Handle non-int exc.status_code in Starlette (#2075) by @sentrivana
Handle SQLAlchemy engine.name being bytes (#2074) by @sentrivana
Fix KeyError in capture_checkin if SDK is not initialized (#2073) by @antonpirker
Use functools.wrap for ThreadingIntegration patches to fix attributes (#2080) by @EpicWink
Pin urllib3 to <2.0.0 for now (#2069) by @sl0thentr0py
Do not send monitor_config when unset (#2058) by @evanpurkhiser
db.system span data (#2040, #2042) by @antonpirkerOne column per quarter.