ref(api): Remove store endpoint

MIGRATION_GUIDE.md

@@ -22,9 +22,17 @@
 - A number of compatibility utilities were removed from `sentry_sdk._compat`: the constants `PY2` and `PY33`; the functions `datetime_utcnow`, `utc_from_timestamp`, `implements_str`, `contextmanager`; and the aliases `text_type`, `string_types`, `number_types`, `int_types`, `iteritems`, `binary_sequence_types`.
 - 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 `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 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 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.
 
 ## Deprecated
+
+- 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.

sentry_sdk/_types.py

@@ -57,7 +57,6 @@
         "monitor",
     ]
     SessionStatus = Literal["ok", "exited", "crashed", "abnormal"]
-    EndpointType = Literal["store", "envelope"]
 
     DurationUnit = Literal[
         "nanosecond",

sentry_sdk/client.py

@@ -17,7 +17,7 @@
     logger,
 )
 from sentry_sdk.serializer import serialize
-from sentry_sdk.tracing import trace, has_tracing_enabled
+from sentry_sdk.tracing import trace
 from sentry_sdk.transport import make_transport
 from sentry_sdk.consts import (
     DEFAULT_MAX_VALUE_LENGTH,
@@ -588,58 +588,40 @@ def capture_event(
         ):
             return None
 
-        tracing_enabled = has_tracing_enabled(self.options)
         attachments = hint.get("attachments")
 
         trace_context = event_opt.get("contexts", {}).get("trace") or {}
         dynamic_sampling_context = trace_context.pop("dynamic_sampling_context", {})
 
-        # If tracing is enabled all events should go to /envelope endpoint.
-        # If no tracing is enabled only transactions, events with attachments, and checkins should go to the /envelope endpoint.
-        should_use_envelope_endpoint = (
-            tracing_enabled
-            or is_transaction
-            or is_checkin
-            or bool(attachments)
-            or bool(self.spotlight)
-        )
-        if should_use_envelope_endpoint:
-            headers = {
-                "event_id": event_opt["event_id"],
-                "sent_at": format_timestamp(datetime.now(timezone.utc)),
-            }
-
-            if dynamic_sampling_context:
-                headers["trace"] = dynamic_sampling_context
-
-            envelope = Envelope(headers=headers)
-
-            if is_transaction:
-                if profile is not None:
-                    envelope.add_profile(profile.to_json(event_opt, self.options))
-                envelope.add_transaction(event_opt)
-            elif is_checkin:
-                envelope.add_checkin(event_opt)
-            else:
-                envelope.add_event(event_opt)
+        headers = {
+            "event_id": event_opt["event_id"],
+            "sent_at": format_timestamp(datetime.now(timezone.utc)),
+        }
 
-            for attachment in attachments or ():
-                envelope.add_item(attachment.to_envelope_item())
+        if dynamic_sampling_context:
+            headers["trace"] = dynamic_sampling_context
 
-            if self.spotlight:
-                self.spotlight.capture_envelope(envelope)
+        envelope = Envelope(headers=headers)
 
-            if self.transport is None:
-                return None
+        if is_transaction:
+            if profile is not None:
+                envelope.add_profile(profile.to_json(event_opt, self.options))
+            envelope.add_transaction(event_opt)
+        elif is_checkin:
+            envelope.add_checkin(event_opt)
+        else:
+            envelope.add_event(event_opt)
 
-            self.transport.capture_envelope(envelope)
+        for attachment in attachments or ():
+            envelope.add_item(attachment.to_envelope_item())
 
-        else:
-            if self.transport is None:
-                return None
+        if self.spotlight:
+            self.spotlight.capture_envelope(envelope)
+
+        if self.transport is None:
+            return None
 
-            # All other events go to the legacy /store/ endpoint (will be removed in the future).
-            self.transport.capture_event(event_opt)
+        self.transport.capture_envelope(envelope)
 
         return event_id
 

sentry_sdk/consts.py

@@ -1,8 +1,21 @@
+from enum import Enum
 from sentry_sdk._types import TYPE_CHECKING
 
 # up top to prevent circular import due to integration import
 DEFAULT_MAX_VALUE_LENGTH = 1024
 
+
+# Also needs to be at the top to prevent circular import
+class EndpointType(Enum):
+    """
+    The type of an endpoint. This is an enum, rather than a constant, for historical reasons
+    (the old /store endpoint). The enum also preserve future compatibility, in case we ever
+    have a new endpoint.
+    """
+
+    ENVELOPE = "envelope"
+
+
 if TYPE_CHECKING:
     import sentry_sdk
 

sentry_sdk/envelope.py

@@ -26,6 +26,12 @@ def parse_json(data):
 
 
 class Envelope:
+    """
+    Represents a Sentry Envelope. The calling code is responsible for adhering to the constraints
+    documented in the Sentry docs: https://develop.sentry.dev/sdk/envelopes/#data-model. In particular,
+    each envelope may have at most one Item with type "event" or "transaction" (but not both).
+    """
+
     def __init__(
         self,
         headers=None,  # type: Optional[Dict[str, Any]]

sentry_sdk/scope.py

@@ -1077,17 +1077,6 @@ def _apply_contexts_to_event(self, event, hint, options):
             else:
                 contexts["trace"] = self.get_trace_context()
 
-        # Add "reply_id" context
-        try:
-            replay_id = contexts["trace"]["dynamic_sampling_context"]["replay_id"]
-        except (KeyError, TypeError):
-            replay_id = None
-
-        if replay_id is not None:
-            contexts["replay"] = {
-                "replay_id": replay_id,
-            }
-
     @_disable_capture
     def apply_to_event(
         self,

sentry_sdk/transport.py

@@ -1,12 +1,14 @@
 import io
+import warnings
 import urllib3
 import certifi
 import gzip
 import time
 from datetime import datetime, timedelta, timezone
 from collections import defaultdict
 
-from sentry_sdk.utils import Dsn, logger, capture_internal_exceptions, json_dumps
+from sentry_sdk.consts import EndpointType
+from sentry_sdk.utils import Dsn, logger, capture_internal_exceptions
 from sentry_sdk.worker import BackgroundWorker
 from sentry_sdk.envelope import Envelope, Item, PayloadRef
 from sentry_sdk._types import TYPE_CHECKING
@@ -25,7 +27,7 @@
     from urllib3.poolmanager import PoolManager
     from urllib3.poolmanager import ProxyManager
 
-    from sentry_sdk._types import Event, EndpointType
+    from sentry_sdk._types import Event
 
     DataCategory = Optional[str]
 
@@ -58,10 +60,21 @@ def capture_event(
     ):
         # type: (...) -> None
         """
+        DEPRECATED: Please use capture_envelope instead.
+
         This gets invoked with the event dictionary when an event should
         be sent to sentry.
         """
-        raise NotImplementedError()
+
+        warnings.warn(
+            "capture_event is deprecated, please use capture_envelope instead!",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
+        envelope = Envelope()
+        envelope.add_event(event)
+        self.capture_envelope(envelope)
 
     def capture_envelope(
         self, envelope  # type: Envelope
@@ -71,9 +84,8 @@ def capture_envelope(
         Send an envelope to Sentry.
 
         Envelopes are a data container format that can hold any type of data
-        submitted to Sentry. We use it for transactions and sessions, but
-        regular "error" events should go through `capture_event` for backwards
-        compat.
+        submitted to Sentry. We use it to send all event data (including errors,
+        transactions, crons checkins, etc.) to Sentry.
         """
         raise NotImplementedError()
 
@@ -83,13 +95,23 @@ def flush(
         callback=None,  # type: Optional[Any]
     ):
         # type: (...) -> None
-        """Wait `timeout` seconds for the current events to be sent out."""
-        pass
+        """
+        Wait `timeout` seconds for the current events to be sent out.
+
+        The default implementation is a no-op, since this method may only be relevant to some transports.
+        Subclasses should override this method if necessary.
+        """
+        return None
 
     def kill(self):
         # type: () -> None
-        """Forcefully kills the transport."""
-        pass
+        """
+        Forcefully kills the transport.
+
+        The default implementation is a no-op, since this method may only be relevant to some transports.
+        Subclasses should override this method if necessary.
+        """
+        return None
 
     def record_lost_event(
         self,
@@ -216,7 +238,7 @@ def _send_request(
         self,
         body,  # type: bytes
         headers,  # type: Dict[str, str]
-        endpoint_type="store",  # type: EndpointType
+        endpoint_type=EndpointType.ENVELOPE,  # type: EndpointType
         envelope=None,  # type: Optional[Envelope]
     ):
         # type: (...) -> None
@@ -333,46 +355,6 @@ def is_healthy(self):
         # type: () -> bool
         return not (self._is_worker_full() or self._is_rate_limited())
 
-    def _send_event(
-        self, event  # type: Event
-    ):
-        # type: (...) -> None
-
-        if self._check_disabled("error"):
-            self.on_dropped_event("self_rate_limits")
-            self.record_lost_event("ratelimit_backoff", data_category="error")
-            return None
-
-        body = io.BytesIO()
-        if self._compresslevel == 0:
-            body.write(json_dumps(event))
-        else:
-            with gzip.GzipFile(
-                fileobj=body, mode="w", compresslevel=self._compresslevel
-            ) as f:
-                f.write(json_dumps(event))
-
-        assert self.parsed_dsn is not None
-        logger.debug(
-            "Sending event, type:%s level:%s event_id:%s project:%s host:%s"
-            % (
-                event.get("type") or "null",
-                event.get("level") or "null",
-                event.get("event_id") or "null",
-                self.parsed_dsn.project_id,
-                self.parsed_dsn.host,
-            )
-        )
-
-        headers = {
-            "Content-Type": "application/json",
-        }
-        if self._compresslevel > 0:
-            headers["Content-Encoding"] = "gzip"
-
-        self._send_request(body.getvalue(), headers=headers)
-        return None
-
     def _send_envelope(
         self, envelope  # type: Envelope
     ):
@@ -430,7 +412,7 @@ def _send_envelope(
         self._send_request(
             body.getvalue(),
             headers=headers,
-            endpoint_type="envelope",
+            endpoint_type=EndpointType.ENVELOPE,
             envelope=envelope,
         )
         return None
@@ -501,23 +483,6 @@ def _make_pool(
         else:
             return urllib3.PoolManager(**opts)
 
-    def capture_event(
-        self, event  # type: Event
-    ):
-        # type: (...) -> None
-        hub = self.hub_cls.current
-
-        def send_event_wrapper():
-            # type: () -> None
-            with hub:
-                with capture_internal_exceptions():
-                    self._send_event(event)
-                    self._flush_client_reports()
-
-        if not self._worker.submit(send_event_wrapper):
-            self.on_dropped_event("full_queue")
-            self.record_lost_event("queue_overflow", data_category="error")
-
     def capture_envelope(
         self, envelope  # type: Envelope
     ):
@@ -555,6 +520,11 @@ def kill(self):
 
 
 class _FunctionTransport(Transport):
+    """
+    DEPRECATED: Users wishing to provide a custom transport should subclass
+    the Transport class, rather than providing a function.
+    """
+
     def __init__(
         self, func  # type: Callable[[Event], None]
     ):
@@ -569,19 +539,33 @@ def capture_event(
         self._func(event)
         return None
 
+    def capture_envelope(self, envelope: Envelope) -> None:
+        # Since function transports expect to be called with an event, we need
+        # to iterate over the envelope and call the function for each event, via
+        # the deprecated capture_event method.
+        event = envelope.get_event()
+        if event is not None:
+            self.capture_event(event)
+
 
 def make_transport(options):
     # type: (Dict[str, Any]) -> Optional[Transport]
     ref_transport = options["transport"]
 
-    # If no transport is given, we use the http transport class
-    if ref_transport is None:
-        transport_cls = HttpTransport  # type: Type[Transport]
-    elif isinstance(ref_transport, Transport):
+    # By default, we use the http transport class
+    transport_cls = HttpTransport  # type: Type[Transport]
+
+    if isinstance(ref_transport, Transport):
         return ref_transport
     elif isinstance(ref_transport, type) and issubclass(ref_transport, Transport):
         transport_cls = ref_transport
     elif callable(ref_transport):
+        warnings.warn(
+            "Function transports are deprecated and will be removed in a future release."
+            "Please provide a Transport instance or subclass, instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return _FunctionTransport(ref_transport)
 
     # if a transport class is given only instantiate it if the dsn is not