sentry-sdk 0.18.0__py2.py3-none-any.whl → 2.46.0__py2.py3-none-any.whl

sentry_sdk/crons/__init__.py

@@ -0,0 +1,10 @@
+from sentry_sdk.crons.api import capture_checkin
+from sentry_sdk.crons.consts import MonitorStatus
+from sentry_sdk.crons.decorator import monitor
+
+
+__all__ = [
+    "capture_checkin",
+    "MonitorStatus",
+    "monitor",
+]

sentry_sdk/crons/api.py

@@ -0,0 +1,62 @@
+import uuid
+
+import sentry_sdk
+from sentry_sdk.utils import logger
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from typing import Optional
+    from sentry_sdk._types import Event, MonitorConfig
+
+
+def _create_check_in_event(
+    monitor_slug=None,  # type: Optional[str]
+    check_in_id=None,  # type: Optional[str]
+    status=None,  # type: Optional[str]
+    duration_s=None,  # type: Optional[float]
+    monitor_config=None,  # type: Optional[MonitorConfig]
+):
+    # type: (...) -> Event
+    options = sentry_sdk.get_client().options
+    check_in_id = check_in_id or uuid.uuid4().hex  # type: str
+
+    check_in = {
+        "type": "check_in",
+        "monitor_slug": monitor_slug,
+        "check_in_id": check_in_id,
+        "status": status,
+        "duration": duration_s,
+        "environment": options.get("environment", None),
+        "release": options.get("release", None),
+    }  # type: Event
+
+    if monitor_config:
+        check_in["monitor_config"] = monitor_config
+
+    return check_in
+
+
+def capture_checkin(
+    monitor_slug=None,  # type: Optional[str]
+    check_in_id=None,  # type: Optional[str]
+    status=None,  # type: Optional[str]
+    duration=None,  # type: Optional[float]
+    monitor_config=None,  # type: Optional[MonitorConfig]
+):
+    # type: (...) -> str
+    check_in_event = _create_check_in_event(
+        monitor_slug=monitor_slug,
+        check_in_id=check_in_id,
+        status=status,
+        duration_s=duration,
+        monitor_config=monitor_config,
+    )
+
+    sentry_sdk.capture_event(check_in_event)
+
+    logger.debug(
+        f"[Crons] Captured check-in ({check_in_event.get('check_in_id')}): {check_in_event.get('monitor_slug')} -> {check_in_event.get('status')}"
+    )
+
+    return check_in_event["check_in_id"]

sentry_sdk/crons/consts.py

@@ -0,0 +1,4 @@
+class MonitorStatus:
+    IN_PROGRESS = "in_progress"
+    OK = "ok"
+    ERROR = "error"

sentry_sdk/crons/decorator.py

@@ -0,0 +1,135 @@
+from functools import wraps
+from inspect import iscoroutinefunction
+
+from sentry_sdk.crons import capture_checkin
+from sentry_sdk.crons.consts import MonitorStatus
+from sentry_sdk.utils import now
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Awaitable, Callable
+    from types import TracebackType
+    from typing import (
+        Any,
+        Optional,
+        ParamSpec,
+        Type,
+        TypeVar,
+        Union,
+        cast,
+        overload,
+    )
+    from sentry_sdk._types import MonitorConfig
+
+    P = ParamSpec("P")
+    R = TypeVar("R")
+
+
+class monitor:  # noqa: N801
+    """
+    Decorator/context manager to capture checkin events for a monitor.
+
+    Usage (as decorator):
+    ```
+    import sentry_sdk
+
+    app = Celery()
+
+    @app.task
+    @sentry_sdk.monitor(monitor_slug='my-fancy-slug')
+    def test(arg):
+        print(arg)
+    ```
+
+    This does not have to be used with Celery, but if you do use it with celery,
+    put the `@sentry_sdk.monitor` decorator below Celery's `@app.task` decorator.
+
+    Usage (as context manager):
+    ```
+    import sentry_sdk
+
+    def test(arg):
+        with sentry_sdk.monitor(monitor_slug='my-fancy-slug'):
+            print(arg)
+    ```
+    """
+
+    def __init__(self, monitor_slug=None, monitor_config=None):
+        # type: (Optional[str], Optional[MonitorConfig]) -> None
+        self.monitor_slug = monitor_slug
+        self.monitor_config = monitor_config
+
+    def __enter__(self):
+        # type: () -> None
+        self.start_timestamp = now()
+        self.check_in_id = capture_checkin(
+            monitor_slug=self.monitor_slug,
+            status=MonitorStatus.IN_PROGRESS,
+            monitor_config=self.monitor_config,
+        )
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        # type: (Optional[Type[BaseException]], Optional[BaseException], Optional[TracebackType]) -> None
+        duration_s = now() - self.start_timestamp
+
+        if exc_type is None and exc_value is None and traceback is None:
+            status = MonitorStatus.OK
+        else:
+            status = MonitorStatus.ERROR
+
+        capture_checkin(
+            monitor_slug=self.monitor_slug,
+            check_in_id=self.check_in_id,
+            status=status,
+            duration=duration_s,
+            monitor_config=self.monitor_config,
+        )
+
+    if TYPE_CHECKING:
+
+        @overload
+        def __call__(self, fn):
+            # type: (Callable[P, Awaitable[Any]]) -> Callable[P, Awaitable[Any]]
+            # Unfortunately, mypy does not give us any reliable way to type check the
+            # return value of an Awaitable (i.e. async function) for this overload,
+            # since calling iscouroutinefunction narrows the type to Callable[P, Awaitable[Any]].
+            ...
+
+        @overload
+        def __call__(self, fn):
+            # type: (Callable[P, R]) -> Callable[P, R]
+            ...
+
+    def __call__(
+        self,
+        fn,  # type: Union[Callable[P, R], Callable[P, Awaitable[Any]]]
+    ):
+        # type: (...) -> Union[Callable[P, R], Callable[P, Awaitable[Any]]]
+        if iscoroutinefunction(fn):
+            return self._async_wrapper(fn)
+
+        else:
+            if TYPE_CHECKING:
+                fn = cast("Callable[P, R]", fn)
+            return self._sync_wrapper(fn)
+
+    def _async_wrapper(self, fn):
+        # type: (Callable[P, Awaitable[Any]]) -> Callable[P, Awaitable[Any]]
+        @wraps(fn)
+        async def inner(*args: "P.args", **kwargs: "P.kwargs"):
+            # type: (...) -> R
+            with self:
+                return await fn(*args, **kwargs)
+
+        return inner
+
+    def _sync_wrapper(self, fn):
+        # type: (Callable[P, R]) -> Callable[P, R]
+        @wraps(fn)
+        def inner(*args: "P.args", **kwargs: "P.kwargs"):
+            # type: (...) -> R
+            with self:
+                return fn(*args, **kwargs)
+
+        return inner

sentry_sdk/debug.py

@@ -1,29 +1,26 @@
 import sys
 import logging
+import warnings
 
-from sentry_sdk import utils
-from sentry_sdk.hub import Hub
-from sentry_sdk.utils import logger
+from sentry_sdk import get_client
 from sentry_sdk.client import _client_init_debug
+from sentry_sdk.utils import logger
 from logging import LogRecord
 
 
-class _HubBasedClientFilter(logging.Filter):
+class _DebugFilter(logging.Filter):
     def filter(self, record):
         # type: (LogRecord) -> bool
         if _client_init_debug.get(False):
             return True
-        hub = Hub.current
-        if hub is not None and hub.client is not None:
-            return hub.client.options["debug"]
-        return False
+
+        return get_client().options["debug"]
 
 
 def init_debug_support():
     # type: () -> None
     if not logger.handlers:
         configure_logger()
-    configure_debug_hub()
 
 
 def configure_logger():
@@ -32,13 +29,13 @@ def configure_logger():
     _handler.setFormatter(logging.Formatter(" [sentry] %(levelname)s: %(message)s"))
     logger.addHandler(_handler)
     logger.setLevel(logging.DEBUG)
-    logger.addFilter(_HubBasedClientFilter())
+    logger.addFilter(_DebugFilter())
 
 
 def configure_debug_hub():
     # type: () -> None
-    def _get_debug_hub():
-        # type: () -> Hub
-        return Hub.current
-
-    utils._get_debug_hub = _get_debug_hub
+    warnings.warn(
+        "configure_debug_hub is deprecated. Please remove calls to it, as it is a no-op.",
+        DeprecationWarning,
+        stacklevel=2,
+    )

sentry_sdk/envelope.py

@@ -1,17 +1,14 @@
 import io
 import json
-import shutil
 import mimetypes
 
-from sentry_sdk._compat import text_type
-from sentry_sdk._types import MYPY
-from sentry_sdk.sessions import Session
-from sentry_sdk.tracing import Transaction
-from sentry_sdk.utils import json_dumps
+from sentry_sdk.session import Session
+from sentry_sdk.utils import json_dumps, capture_internal_exceptions
 
-if MYPY:
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
     from typing import Any
-    from typing import Tuple
     from typing import Optional
     from typing import Union
     from typing import Dict
@@ -21,10 +18,24 @@ if MYPY:
     from sentry_sdk._types import Event, EventDataCategory
 
 
-class Envelope(object):
+def parse_json(data):
+    # type: (Union[bytes, str]) -> Any
+    # on some python 3 versions this needs to be bytes
+    if isinstance(data, bytes):
+        data = data.decode("utf-8", "replace")
+    return json.loads(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, str]]
+        headers=None,  # type: Optional[Dict[str, Any]]
         items=None,  # type: Optional[List[Item]]
     ):
         # type: (...) -> None
@@ -46,27 +57,65 @@ class Envelope(object):
         )
 
     def add_event(
-        self, event  # type: Event
+        self,
+        event,  # type: Event
     ):
         # type: (...) -> None
         self.add_item(Item(payload=PayloadRef(json=event), type="event"))
 
     def add_transaction(
-        self, transaction  # type: Transaction
+        self,
+        transaction,  # type: Event
     ):
         # type: (...) -> None
         self.add_item(Item(payload=PayloadRef(json=transaction), type="transaction"))
 
+    def add_profile(
+        self,
+        profile,  # type: Any
+    ):
+        # type: (...) -> None
+        self.add_item(Item(payload=PayloadRef(json=profile), type="profile"))
+
+    def add_profile_chunk(
+        self,
+        profile_chunk,  # type: Any
+    ):
+        # type: (...) -> None
+        self.add_item(
+            Item(
+                payload=PayloadRef(json=profile_chunk),
+                type="profile_chunk",
+                headers={"platform": profile_chunk.get("platform", "python")},
+            )
+        )
+
+    def add_checkin(
+        self,
+        checkin,  # type: Any
+    ):
+        # type: (...) -> None
+        self.add_item(Item(payload=PayloadRef(json=checkin), type="check_in"))
+
     def add_session(
-        self, session  # type: Union[Session, Any]
+        self,
+        session,  # type: Union[Session, Any]
     ):
         # type: (...) -> None
         if isinstance(session, Session):
             session = session.to_json()
         self.add_item(Item(payload=PayloadRef(json=session), type="session"))
 
+    def add_sessions(
+        self,
+        sessions,  # type: Any
+    ):
+        # type: (...) -> None
+        self.add_item(Item(payload=PayloadRef(json=sessions), type="sessions"))
+
     def add_item(
-        self, item  # type: Item
+        self,
+        item,  # type: Item
     ):
         # type: (...) -> None
         self.items.append(item)
@@ -92,7 +141,8 @@ class Envelope(object):
         return iter(self.items)
 
     def serialize_into(
-        self, f  # type: Any
+        self,
+        f,  # type: Any
     ):
         # type: (...) -> None
         f.write(json_dumps(self.headers))
@@ -108,10 +158,11 @@ class Envelope(object):
 
     @classmethod
     def deserialize_from(
-        cls, f  # type: Any
+        cls,
+        f,  # type: Any
     ):
         # type: (...) -> Envelope
-        headers = json.loads(f.readline())
+        headers = parse_json(f.readline())
         items = []
         while 1:
             item = Item.deserialize_from(f)
@@ -122,7 +173,8 @@ class Envelope(object):
 
     @classmethod
     def deserialize(
-        cls, bytes  # type: bytes
+        cls,
+        bytes,  # type: bytes
     ):
         # type: (...) -> Envelope
         return cls.deserialize_from(io.BytesIO(bytes))
@@ -132,11 +184,11 @@ class Envelope(object):
         return "<Envelope headers=%r items=%r>" % (self.headers, self.items)
 
 
-class PayloadRef(object):
+class PayloadRef:
     def __init__(
         self,
         bytes=None,  # type: Optional[bytes]
-        path=None,  # type: Optional[Union[bytes, text_type]]
+        path=None,  # type: Optional[Union[bytes, str]]
         json=None,  # type: Optional[Any]
     ):
         # type: (...) -> None
@@ -148,33 +200,12 @@ class PayloadRef(object):
         # type: (...) -> bytes
         if self.bytes is None:
             if self.path is not None:
-                with open(self.path, "rb") as f:
-                    self.bytes = f.read()
+                with capture_internal_exceptions():
+                    with open(self.path, "rb") as f:
+                        self.bytes = f.read()
             elif self.json is not None:
                 self.bytes = json_dumps(self.json)
-            else:
-                self.bytes = b""
-        return self.bytes
-
-    def _prepare_serialize(self):
-        # type: (...) -> Tuple[Any, Any]
-        if self.path is not None and self.bytes is None:
-            f = open(self.path, "rb")
-            f.seek(0, 2)
-            length = f.tell()
-            f.seek(0, 0)
-
-            def writer(out):
-                # type: (Any) -> None
-                try:
-                    shutil.copyfileobj(f, out)
-                finally:
-                    f.close()
-
-            return length, writer
-
-        bytes = self.get_bytes()
-        return len(bytes), lambda f: f.write(bytes)
+        return self.bytes or b""
 
     @property
     def inferred_content_type(self):
@@ -195,11 +226,11 @@ class PayloadRef(object):
         return "<Payload %r>" % (self.inferred_content_type,)
 
 
-class Item(object):
+class Item:
     def __init__(
         self,
-        payload,  # type: Union[bytes, text_type, PayloadRef]
-        headers=None,  # type: Optional[Dict[str, str]]
+        payload,  # type: Union[bytes, str, PayloadRef]
+        headers=None,  # type: Optional[Dict[str, Any]]
         type=None,  # type: Optional[str]
         content_type=None,  # type: Optional[str]
         filename=None,  # type: Optional[str]
@@ -211,7 +242,7 @@ class Item(object):
         self.headers = headers
         if isinstance(payload, bytes):
             payload = PayloadRef(bytes=payload)
-        elif isinstance(payload, text_type):
+        elif isinstance(payload, str):
             payload = PayloadRef(bytes=payload.encode("utf-8"))
         else:
             payload = payload
@@ -244,7 +275,7 @@ class Item(object):
     def data_category(self):
         # type: (...) -> EventDataCategory
         ty = self.headers.get("type")
-        if ty == "session":
+        if ty == "session" or ty == "sessions":
             return "session"
         elif ty == "attachment":
             return "attachment"
@@ -252,6 +283,18 @@ class Item(object):
             return "transaction"
         elif ty == "event":
             return "error"
+        elif ty == "log":
+            return "log_item"
+        elif ty == "trace_metric":
+            return "trace_metric"
+        elif ty == "client_report":
+            return "internal"
+        elif ty == "profile":
+            return "profile"
+        elif ty == "profile_chunk":
+            return "profile_chunk"
+        elif ty == "check_in":
+            return "monitor"
         else:
             return "default"
 
@@ -275,15 +318,16 @@ class Item(object):
         return None
 
     def serialize_into(
-        self, f  # type: Any
+        self,
+        f,  # type: Any
     ):
         # type: (...) -> None
         headers = dict(self.headers)
-        length, writer = self.payload._prepare_serialize()
-        headers["length"] = length
+        bytes = self.get_bytes()
+        headers["length"] = len(bytes)
         f.write(json_dumps(headers))
         f.write(b"\n")
-        writer(f)
+        f.write(bytes)
         f.write(b"\n")
 
     def serialize(self):
@@ -294,25 +338,32 @@ class Item(object):
 
     @classmethod
     def deserialize_from(
-        cls, f  # type: Any
+        cls,
+        f,  # type: Any
     ):
         # type: (...) -> Optional[Item]
         line = f.readline().rstrip()
         if not line:
             return None
-        headers = json.loads(line)
-        length = headers["length"]
-        payload = f.read(length)
+        headers = parse_json(line)
+        length = headers.get("length")
+        if length is not None:
+            payload = f.read(length)
+            f.readline()
+        else:
+            # if no length was specified we need to read up to the end of line
+            # and remove it (if it is present, i.e. not the very last char in an eof terminated envelope)
+            payload = f.readline().rstrip(b"\n")
         if headers.get("type") in ("event", "transaction"):
-            rv = cls(headers=headers, payload=PayloadRef(json=json.loads(payload)))
+            rv = cls(headers=headers, payload=PayloadRef(json=parse_json(payload)))
         else:
             rv = cls(headers=headers, payload=payload)
-        f.readline()
         return rv
 
     @classmethod
     def deserialize(
-        cls, bytes  # type: bytes
+        cls,
+        bytes,  # type: bytes
     ):
         # type: (...) -> Optional[Item]
         return cls.deserialize_from(io.BytesIO(bytes))

sentry_sdk/feature_flags.py

@@ -0,0 +1,71 @@
+import copy
+import sentry_sdk
+from sentry_sdk._lru_cache import LRUCache
+from threading import Lock
+
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from typing import TypedDict
+
+    FlagData = TypedDict("FlagData", {"flag": str, "result": bool})
+
+
+DEFAULT_FLAG_CAPACITY = 100
+
+
+class FlagBuffer:
+    def __init__(self, capacity):
+        # type: (int) -> None
+        self.capacity = capacity
+        self.lock = Lock()
+
+        # Buffer is private. The name is mangled to discourage use. If you use this attribute
+        # directly you're on your own!
+        self.__buffer = LRUCache(capacity)
+
+    def clear(self):
+        # type: () -> None
+        self.__buffer = LRUCache(self.capacity)
+
+    def __deepcopy__(self, memo):
+        # type: (dict[int, Any]) -> FlagBuffer
+        with self.lock:
+            buffer = FlagBuffer(self.capacity)
+            buffer.__buffer = copy.deepcopy(self.__buffer, memo)
+            return buffer
+
+    def get(self):
+        # type: () -> list[FlagData]
+        with self.lock:
+            return [
+                {"flag": key, "result": value} for key, value in self.__buffer.get_all()
+            ]
+
+    def set(self, flag, result):
+        # type: (str, bool) -> None
+        if isinstance(result, FlagBuffer):
+            # If someone were to insert `self` into `self` this would create a circular dependency
+            # on the lock. This is of course a deadlock. However, this is far outside the expected
+            # usage of this class. We guard against it here for completeness and to document this
+            # expected failure mode.
+            raise ValueError(
+                "FlagBuffer instances can not be inserted into the dictionary."
+            )
+
+        with self.lock:
+            self.__buffer.set(flag, result)
+
+
+def add_feature_flag(flag, result):
+    # type: (str, bool) -> None
+    """
+    Records a flag and its value to be sent on subsequent error events.
+    We recommend you do this on flag evaluations. Flags are buffered per Sentry scope.
+    """
+    flags = sentry_sdk.get_isolation_scope().flags
+    flags.set(flag, result)
+
+    span = sentry_sdk.get_current_span()
+    if span:
+        span.set_flag(f"flag.evaluation.{flag}", result)