remove enable_tracing

Author: sentrivana

sentry_sdk/client.py

@@ -9,7 +9,6 @@
 from datetime import datetime, timezone
 from importlib import import_module
 from typing import TYPE_CHECKING, List, Dict, cast, overload
-import warnings
 
 from sentry_sdk._compat import check_uwsgi_thread_support
 from sentry_sdk.utils import (
@@ -121,9 +120,6 @@ def _get_options(*args, **kwargs):
 
         rv["project_root"] = project_root
 
-    if rv["enable_tracing"] is True and rv["traces_sample_rate"] is None:
-        rv["traces_sample_rate"] = 1.0
-
     if rv["event_scrubber"] is None:
         rv["event_scrubber"] = EventScrubber(
             send_default_pii=(
@@ -137,13 +133,6 @@ def _get_options(*args, **kwargs):
         )
         rv["socket_options"] = None
 
-    if rv["enable_tracing"] is not None:
-        warnings.warn(
-            "The `enable_tracing` parameter is deprecated. Please use `traces_sample_rate` instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-
     return rv
 
 

sentry_sdk/consts.py

@@ -526,7 +526,6 @@ def __init__(
         proxy_headers=None,  # type: Optional[Dict[str, str]]
         before_send_transaction=None,  # type: Optional[TransactionProcessor]
         project_root=None,  # type: Optional[str]
-        enable_tracing=None,  # type: Optional[bool]
         include_local_variables=True,  # type: Optional[bool]
         include_source_context=True,  # type: Optional[bool]
         trace_propagation_targets=[  # noqa: B006
@@ -915,9 +914,6 @@ def __init__(
 
         :param profile_session_sample_rate:
 
-
-        :param enable_tracing:
-
         :param propagate_traces:
 
         :param auto_session_tracking:

sentry_sdk/tracing_utils.py

@@ -93,17 +93,14 @@ def has_tracing_enabled(options):
     # type: (Optional[Dict[str, Any]]) -> bool
     """
     Returns True if either traces_sample_rate or traces_sampler is
-    defined and enable_tracing is set and not false.
+    defined.
     """
     if options is None:
         return False
 
     return bool(
-        options.get("enable_tracing") is not False
-        and (
-            options.get("traces_sample_rate") is not None
-            or options.get("traces_sampler") is not None
-        )
+        options.get("traces_sample_rate") is not None
+        or options.get("traces_sampler") is not None
     )
 
 

tests/integrations/celery/test_update_celery_task_headers.py

@@ -71,7 +71,7 @@ def test_monitor_beat_tasks_with_headers(monitor_beat_tasks):
 
 
 def test_span_with_transaction(sentry_init):
-    sentry_init(enable_tracing=True)
+    sentry_init(traces_sample_rate=1.0)
     headers = {}
     monitor_beat_tasks = False
 
@@ -91,7 +91,7 @@ def test_span_with_transaction(sentry_init):
 
 
 def test_span_with_transaction_custom_headers(sentry_init):
-    sentry_init(enable_tracing=True)
+    sentry_init(traces_sample_rate=1.0)
     headers = {
         "baggage": BAGGAGE_VALUE,
         "sentry-trace": SENTRY_TRACE_VALUE,
@@ -190,39 +190,3 @@ def test_celery_trace_propagation_traces_sample_rate(
     else:
         assert "sentry-monitor-start-timestamp-s" not in outgoing_headers
         assert "sentry-monitor-start-timestamp-s" not in outgoing_headers["headers"]
-
-
-@pytest.mark.parametrize(
-    "enable_tracing,monitor_beat_tasks",
-    list(itertools.product([None, True, False], [True, False])),
-)
-def test_celery_trace_propagation_enable_tracing(
-    sentry_init, enable_tracing, monitor_beat_tasks
-):
-    """
-    The celery integration does not check the traces_sample_rate.
-    By default traces_sample_rate is None which means "do not propagate traces".
-    But the celery integration does not check this value.
-    The Celery integration has its own mechanism to propagate traces:
-    https://docs.sentry.io/platforms/python/integrations/celery/#distributed-traces
-    """
-    sentry_init(enable_tracing=enable_tracing)
-
-    headers = {}
-    span = None
-
-    scope = sentry_sdk.get_isolation_scope()
-
-    outgoing_headers = _update_celery_task_headers(headers, span, monitor_beat_tasks)
-
-    assert outgoing_headers["sentry-trace"] == scope.get_traceparent()
-    assert outgoing_headers["headers"]["sentry-trace"] == scope.get_traceparent()
-    assert outgoing_headers["baggage"] == scope.get_baggage().serialize()
-    assert outgoing_headers["headers"]["baggage"] == scope.get_baggage().serialize()
-
-    if monitor_beat_tasks:
-        assert "sentry-monitor-start-timestamp-s" in outgoing_headers
-        assert "sentry-monitor-start-timestamp-s" in outgoing_headers["headers"]
-    else:
-        assert "sentry-monitor-start-timestamp-s" not in outgoing_headers
-        assert "sentry-monitor-start-timestamp-s" not in outgoing_headers["headers"]

tests/integrations/graphene/test_graphene.py

@@ -207,7 +207,7 @@ def graphql_server_sync():
 def test_graphql_span_holds_query_information(sentry_init, capture_events):
     sentry_init(
         integrations=[GrapheneIntegration(), FlaskIntegration()],
-        enable_tracing=True,
+        traces_sample_rate=1.0,
         default_integrations=False,
     )
     events = capture_events()

tests/integrations/sqlalchemy/test_sqlalchemy.py

@@ -295,14 +295,12 @@ def test_engine_name_not_string(sentry_init):
 
 
 def test_query_source_disabled(sentry_init, capture_events):
-    sentry_options = {
-        "integrations": [SqlalchemyIntegration()],
-        "enable_tracing": True,
-        "enable_db_query_source": False,
-        "db_query_source_threshold_ms": 0,
-    }
-
-    sentry_init(**sentry_options)
+    sentry_init(
+        integrations=[SqlalchemyIntegration()],
+        traces_sample_rate=1.0,
+        enable_db_query_source=False,
+        db_query_source_threshold_ms=0,
+    )
 
     events = capture_events()
 
@@ -348,7 +346,7 @@ class Person(Base):
 def test_query_source_enabled(sentry_init, capture_events, enable_db_query_source):
     sentry_options = {
         "integrations": [SqlalchemyIntegration()],
-        "enable_tracing": True,
+        "traces_sample_rate": 1.0,
         "db_query_source_threshold_ms": 0,
     }
     if enable_db_query_source is not None:
@@ -399,7 +397,7 @@ class Person(Base):
 def test_query_source(sentry_init, capture_events):
     sentry_init(
         integrations=[SqlalchemyIntegration()],
-        enable_tracing=True,
+        traces_sample_rate=1.0,
         enable_db_query_source=True,
         db_query_source_threshold_ms=0,
     )
@@ -464,7 +462,7 @@ def test_query_source_with_module_in_search_path(sentry_init, capture_events):
     """
     sentry_init(
         integrations=[SqlalchemyIntegration()],
-        enable_tracing=True,
+        traces_sample_rate=1.0,
         enable_db_query_source=True,
         db_query_source_threshold_ms=0,
     )
@@ -527,7 +525,7 @@ class Person(Base):
 def test_no_query_source_if_duration_too_short(sentry_init, capture_events):
     sentry_init(
         integrations=[SqlalchemyIntegration()],
-        enable_tracing=True,
+        traces_sample_rate=1.0,
         enable_db_query_source=True,
         db_query_source_threshold_ms=100,
     )
@@ -595,7 +593,7 @@ def __exit__(self, type, value, traceback):
 def test_query_source_if_duration_over_threshold(sentry_init, capture_events):
     sentry_init(
         integrations=[SqlalchemyIntegration()],
-        enable_tracing=True,
+        traces_sample_rate=1.0,
         enable_db_query_source=True,
         db_query_source_threshold_ms=100,
     )

tests/test_basics.py

@@ -33,7 +33,6 @@
 from sentry_sdk.integrations.stdlib import StdlibIntegration
 from sentry_sdk.scope import add_global_event_processor
 from sentry_sdk.utils import datetime_from_isoformat, get_sdk_name, reraise
-from sentry_sdk.tracing_utils import has_tracing_enabled
 
 
 class NoOpIntegration(Integration):
@@ -249,32 +248,6 @@ def do_this():
     assert crumb["type"] == "default"
 
 
-@pytest.mark.parametrize(
-    "enable_tracing, traces_sample_rate, tracing_enabled, updated_traces_sample_rate",
-    [
-        (None, None, False, None),
-        (False, 0.0, False, 0.0),
-        (False, 1.0, False, 1.0),
-        (None, 1.0, True, 1.0),
-        (True, 1.0, True, 1.0),
-        (None, 0.0, True, 0.0),  # We use this as - it's configured but turned off
-        (True, 0.0, True, 0.0),  # We use this as - it's configured but turned off
-        (True, None, True, 1.0),
-    ],
-)
-def test_option_enable_tracing(
-    sentry_init,
-    enable_tracing,
-    traces_sample_rate,
-    tracing_enabled,
-    updated_traces_sample_rate,
-):
-    sentry_init(enable_tracing=enable_tracing, traces_sample_rate=traces_sample_rate)
-    options = sentry_sdk.get_client().options
-    assert has_tracing_enabled(options) is tracing_enabled
-    assert options["traces_sample_rate"] == updated_traces_sample_rate
-
-
 def test_breadcrumb_arguments(sentry_init, capture_events):
     assert_hint = {"bar": 42}
 
@@ -839,7 +812,7 @@ def test_classmethod_tracing(sentry_init):
 
 
 def test_last_event_id(sentry_init):
-    sentry_init(enable_tracing=True)
+    sentry_init(traces_sample_rate=1.0)
 
     assert last_event_id() is None
 
@@ -849,7 +822,7 @@ def test_last_event_id(sentry_init):
 
 
 def test_last_event_id_transaction(sentry_init):
-    sentry_init(enable_tracing=True)
+    sentry_init(traces_sample_rate=1.0)
 
     assert last_event_id() is None
 
@@ -860,7 +833,7 @@ def test_last_event_id_transaction(sentry_init):
 
 
 def test_last_event_id_scope(sentry_init):
-    sentry_init(enable_tracing=True)
+    sentry_init(traces_sample_rate=1.0)
 
     # Should not crash
     with isolation_scope() as scope:

tests/test_client.py

@@ -1440,9 +1440,3 @@ def run(self, sentry_init, capture_record_lost_event_calls):
 )
 def test_dropped_transaction(sentry_init, capture_record_lost_event_calls, test_config):
     test_config.run(sentry_init, capture_record_lost_event_calls)
-
-
-@pytest.mark.parametrize("enable_tracing", [True, False])
-def test_enable_tracing_deprecated(sentry_init, enable_tracing):
-    with pytest.warns(DeprecationWarning):
-        sentry_init(enable_tracing=enable_tracing)

tests/test_scope.py

@@ -884,7 +884,7 @@ def test_set_tags():
 
 
 def test_last_event_id(sentry_init):
-    sentry_init(enable_tracing=True)
+    sentry_init(traces_sample_rate=1.0)
 
     assert Scope.last_event_id() is None
 
@@ -894,7 +894,7 @@ def test_last_event_id(sentry_init):
 
 
 def test_last_event_id_transaction(sentry_init):
-    sentry_init(enable_tracing=True)
+    sentry_init(traces_sample_rate=1.0)
 
     assert Scope.last_event_id() is None
 
@@ -905,7 +905,7 @@ def test_last_event_id_transaction(sentry_init):
 
 
 def test_last_event_id_cleared(sentry_init):
-    sentry_init(enable_tracing=True)
+    sentry_init(traces_sample_rate=1.0)
 
     # Make sure last_event_id is set
     sentry_sdk.capture_exception(Exception("test"))