2.0.0rc5

Update CHANGELOG.md

1.45.0

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.

Various fixes & improvements

• 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

2.0.0rc4

New Features

• 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.
• Added new API for custom instrumentation: new_scope, isolation_scope. See the Deprecated section to see how they map to the existing APIs.

Changed

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

  Show table

  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

Removed

• Removed support for Python 2 and Python 3.5. The SDK now requires at least Python 3.6.
• Removed support for Celery 3.*.
• Removed support for Django 1.8, 1.9, 1.10.
• Removed support for Flask 0.*.
• Removed support for gRPC < 1.39.
• Removed support for Tornado < 6.
• 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.
• 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.
• 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.
• 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.
• Removed support for user.segment. It was also removed from the trace header as well as from the dynamic sampling context.
• Removed support for the install method for custom integrations. Please use setup_once instead.
• Removed sentry_sdk.tracing.Span.new_span. Use sentry_sdk.tracing.Span.start_child instead.
• Removed sentry_sdk.tracing.Transaction.new_span. Use sentry_sdk.tracing.Transaction.start_child instead.
• Removed support for creating transactions via sentry_sdk.tracing.Span(transaction=...). To create a transaction, please use sentry_sdk.tracing.Transaction(name=...).
• Removed 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.
• Removed tracing_utils_py2.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.
• 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.

Deprecated

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

1.44.1

Various fixes & improvements

• 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

1.44.0

Various fixes & improvements

• ref: Define types at runtime (#2914) by @szokeasaurusrex
• Explicit reexport of types (#2866) (#2913) by @szokeasaurusrex
• feat(profiling): Add thread data to spans (#2843) by @Zylphrex

2.0.0rc3

Various fixes & improvements

• Use new scopes API default integrations. (#2856) by @antonpirker
• Use new scopes API in openai integration (#2853) by @antonpirker
• Use new scopes API in Celery integration. (#2851) by @antonpirker
• Use new scopes API in Django, SQLAlchemy, and asyncpg integration. (#2845) by @antonpirker
• Use new scopes API in Redis (#2854) by @sentrivana
• Use new scopes API in GQL Integration (#2838) by @szokeasaurusrex
• Use new scopes API in LoggingIntegration (#2861, #2855) by @sentrivana
• Use new scopes API in FastAPI integration (#2836) by @szokeasaurusrex
• Use new scopes API in Ariadne (#2850) by @szokeasaurusrex
• Add optional keep_alive (#2842) by @sentrivana
• Add support for celery-redbeat cron tasks (#2643) by @kwigley
• AWS Lambda: aws_event can be an empty list (#2849) by @sentrivana
• GQL: Remove problematic tests (#2835) by @szokeasaurusrex
• Moved should_send_default_pii into client (#2840) by @antonpirker
• should_send_default_pii shortcut (#2844) by @szokeasaurusrex
• Use scope.should_send_default_pii in FastAPI integration (#2846) by @szokeasaurusrex
• Patched functions decorator for integrations (#2454) by @szokeasaurusrex
• Small APIdocs improvement (#2828) by @antonpirker
• Bump checkouts/data-schemas from ed078ed to 8232f17 (#2832) by @dependabot
• Update CHANGELOG.md (970c577) by @sentrivana
• Updated migration guide (#2859) by @antonpirker

Plus 2 more

1.43.0

Various fixes & improvements

• 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

2.0.0rc2

New Features

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

Changed

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

  Show table

  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

Removed

• Removed support for Python 2 and Python 3.5. The SDK now requires at least Python 3.6.
• Removed support for Celery 3.*.
• Removed support for Django 1.8, 1.9, 1.10.
• Removed support for Flask 0.*.
• Removed support for gRPC < 1.39.
• 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.
• 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.
• 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.
• 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.
• Removed support for user.segment. It was also removed from the trace header as well as from the dynamic sampling context.
• Removed support for the install method for custom integrations. Please use setup_once instead.
• Removed sentry_sdk.tracing.Span.new_span. Use sentry_sdk.tracing.Span.start_child instead.
• Removed sentry_sdk.tracing.Transaction.new_span. Use sentry_sdk.tracing.Transaction.start_child instead.
• Removed 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.
• Removed tracing_utils_py2.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.
• 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.

Deprecated

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

1.42.0

Various fixes & improvements

• 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

2.0.0rc1

New Features

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

Changed

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

  Show table

  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

Removed

• Removed support for Python 2 and Python 3.5. The SDK now requires at least Python 3.6.
• Removed support for Celery 3.*.
• Removed support for Django 1.8, 1.9, 1.10.
• Removed support for Flask 0.*.
• 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.
• 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.
• 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.
• 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.
• Removed support for user.segment. It was also removed from the trace header as well as from the dynamic sampling context.
• Removed support for the install method for custom integrations. Please use setup_once instead.
• Removed sentry_sdk.tracing.Span.new_span. Use sentry_sdk.tracing.Span.start_child instead.
• Removed sentry_sdk.tracing.Transaction.new_span. Use sentry_sdk.tracing.Transaction.start_child instead.
• Removed 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.
• Removed tracing_utils_py2.py. The start_child_span_decorator is now in sentry_sdk.tracing_utils.
• 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.

Deprecated

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