Merge branch 'master' into ivana/toxgen/move-even-more-stuff

Author: sentrivana

.github/workflows/release.yml

@@ -20,7 +20,7 @@ jobs:
     steps:
       - name: Get auth token
         id: token
-        uses: actions/create-github-app-token@3ff1caaa28b64c9cc276ce0a02e2ff584f3900c5 # v2.0.2
+        uses: actions/create-github-app-token@df432ceedc7162793a195dd1713ff69aefc7379e # v2.0.6
         with:
           app-id: ${{ vars.SENTRY_RELEASE_BOT_CLIENT_ID }}
           private-key: ${{ secrets.SENTRY_RELEASE_BOT_PRIVATE_KEY }}

docs/api.rst

@@ -25,6 +25,7 @@ Capturing Data
 Enriching Events
 ================
 
+.. autofunction:: sentry_sdk.api.add_attachment
 .. autofunction:: sentry_sdk.api.add_breadcrumb
 .. autofunction:: sentry_sdk.api.set_context
 .. autofunction:: sentry_sdk.api.set_extra
@@ -63,4 +64,3 @@ Managing Scope (advanced)
 .. autofunction:: sentry_sdk.api.push_scope
 
 .. autofunction:: sentry_sdk.api.new_scope
-

sentry_sdk/__init__.py

@@ -15,6 +15,7 @@
     "integrations",
     # From sentry_sdk.api
     "init",
+    "add_attachment",
     "add_breadcrumb",
     "capture_event",
     "capture_exception",

sentry_sdk/_log_batcher.py

@@ -5,7 +5,7 @@
 from typing import Optional, List, Callable, TYPE_CHECKING, Any
 
 from sentry_sdk.utils import format_timestamp, safe_repr
-from sentry_sdk.envelope import Envelope
+from sentry_sdk.envelope import Envelope, Item, PayloadRef
 
 if TYPE_CHECKING:
     from sentry_sdk._types import Log
@@ -97,34 +97,36 @@ def flush(self):
         self._flush()
 
     @staticmethod
-    def _log_to_otel(log):
+    def _log_to_transport_format(log):
         # type: (Log) -> Any
-        def format_attribute(key, val):
-            # type: (str, int | float | str | bool) -> Any
+        def format_attribute(val):
+            # type: (int | float | str | bool) -> Any
             if isinstance(val, bool):
-                return {"key": key, "value": {"boolValue": val}}
+                return {"value": val, "type": "boolean"}
             if isinstance(val, int):
-                return {"key": key, "value": {"intValue": str(val)}}
+                return {"value": val, "type": "integer"}
             if isinstance(val, float):
-                return {"key": key, "value": {"doubleValue": val}}
+                return {"value": val, "type": "double"}
             if isinstance(val, str):
-                return {"key": key, "value": {"stringValue": val}}
-            return {"key": key, "value": {"stringValue": safe_repr(val)}}
-
-        otel_log = {
-            "severityText": log["severity_text"],
-            "severityNumber": log["severity_number"],
-            "body": {"stringValue": log["body"]},
-            "timeUnixNano": str(log["time_unix_nano"]),
-            "attributes": [
-                format_attribute(k, v) for (k, v) in log["attributes"].items()
-            ],
+                return {"value": val, "type": "string"}
+            return {"value": safe_repr(val), "type": "string"}
+
+        if "sentry.severity_number" not in log["attributes"]:
+            log["attributes"]["sentry.severity_number"] = log["severity_number"]
+        if "sentry.severity_text" not in log["attributes"]:
+            log["attributes"]["sentry.severity_text"] = log["severity_text"]
+
+        res = {
+            "timestamp": int(log["time_unix_nano"]) / 1.0e9,
+            "trace_id": log.get("trace_id", "00000000-0000-0000-0000-000000000000"),
+            "level": str(log["severity_text"]),
+            "body": str(log["body"]),
+            "attributes": {
+                k: format_attribute(v) for (k, v) in log["attributes"].items()
+            },
         }
 
-        if "trace_id" in log:
-            otel_log["traceId"] = log["trace_id"]
-
-        return otel_log
+        return res
 
     def _flush(self):
         # type: (...) -> Optional[Envelope]
@@ -133,10 +135,27 @@ def _flush(self):
             headers={"sent_at": format_timestamp(datetime.now(timezone.utc))}
         )
         with self._lock:
-            for log in self._log_buffer:
-                envelope.add_log(self._log_to_otel(log))
+            if len(self._log_buffer) == 0:
+                return None
+
+            envelope.add_item(
+                Item(
+                    type="log",
+                    content_type="application/vnd.sentry.items.log+json",
+                    headers={
+                        "item_count": len(self._log_buffer),
+                    },
+                    payload=PayloadRef(
+                        json={
+                            "items": [
+                                self._log_to_transport_format(log)
+                                for log in self._log_buffer
+                            ]
+                        }
+                    ),
+                )
+            )
             self._log_buffer.clear()
-        if envelope.items:
-            self._capture_func(envelope)
-            return envelope
-        return None
+
+        self._capture_func(envelope)
+        return envelope

sentry_sdk/api.py

@@ -51,6 +51,7 @@ def overload(x):
 # When changing this, update __all__ in __init__.py too
 __all__ = [
     "init",
+    "add_attachment",
     "add_breadcrumb",
     "capture_event",
     "capture_exception",
@@ -184,6 +185,20 @@ def capture_exception(
     return get_current_scope().capture_exception(error, scope=scope, **scope_kwargs)
 
 
+@scopemethod
+def add_attachment(
+    bytes=None,  # type: Union[None, bytes, Callable[[], bytes]]
+    filename=None,  # type: Optional[str]
+    path=None,  # type: Optional[str]
+    content_type=None,  # type: Optional[str]
+    add_to_transactions=False,  # type: bool
+):
+    # type: (...) -> None
+    return get_isolation_scope().add_attachment(
+        bytes, filename, path, content_type, add_to_transactions
+    )
+
+
 @scopemethod
 def add_breadcrumb(
     crumb=None,  # type: Optional[Breadcrumb]

sentry_sdk/envelope.py

@@ -106,12 +106,6 @@ def add_sessions(
         # type: (...) -> None
         self.add_item(Item(payload=PayloadRef(json=sessions), type="sessions"))
 
-    def add_log(
-        self, log  # type: Any
-    ):
-        # type: (...) -> None
-        self.add_item(Item(payload=PayloadRef(json=log), type="otel_log"))
-
     def add_item(
         self, item  # type: Item
     ):
@@ -278,7 +272,7 @@ def data_category(self):
             return "transaction"
         elif ty == "event":
             return "error"
-        elif ty == "otel_log":
+        elif ty == "log":
             return "log"
         elif ty == "client_report":
             return "internal"

sentry_sdk/feature_flags.py

@@ -64,7 +64,7 @@ def add_feature_flag(flag, result):
     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_current_scope().flags
+    flags = sentry_sdk.get_isolation_scope().flags
     flags.set(flag, result)
 
     span = sentry_sdk.get_current_span()

sentry_sdk/integrations/logging.py

@@ -355,6 +355,7 @@ def _capture_log_from_record(client, record):
         # type: (BaseClient, LogRecord) -> None
         scope = sentry_sdk.get_current_scope()
         otel_severity_number, otel_severity_text = _python_level_to_otel(record.levelno)
+        project_root = client.options["project_root"]
         attrs = {
             "sentry.origin": "auto.logger.log",
         }  # type: dict[str, str | bool | float | int]
@@ -374,7 +375,10 @@ def _capture_log_from_record(client, record):
         if record.lineno:
             attrs["code.line.number"] = record.lineno
         if record.pathname:
-            attrs["code.file.path"] = record.pathname
+            if project_root is not None and record.pathname.startswith(project_root):
+                attrs["code.file.path"] = record.pathname[len(project_root) + 1 :]
+            else:
+                attrs["code.file.path"] = record.pathname
         if record.funcName:
             attrs["code.function.name"] = record.funcName
 

tests/integrations/fastapi/test_fastapi.py

@@ -10,7 +10,9 @@
 from fastapi.testclient import TestClient
 from fastapi.middleware.trustedhost import TrustedHostMiddleware
 
+import sentry_sdk
 from sentry_sdk import capture_message
+from sentry_sdk.feature_flags import add_feature_flag
 from sentry_sdk.integrations.asgi import SentryAsgiMiddleware
 from sentry_sdk.integrations.fastapi import FastApiIntegration
 from sentry_sdk.integrations.starlette import StarletteIntegration
@@ -714,3 +716,41 @@ async def subapp_route():
         assert event["transaction"] == "/subapp"
     else:
         assert event["transaction"].endswith("subapp_route")
+
+
+@pytest.mark.asyncio
+async def test_feature_flags(sentry_init, capture_events):
+    sentry_init(
+        traces_sample_rate=1.0,
+        integrations=[StarletteIntegration(), FastApiIntegration()],
+    )
+
+    events = capture_events()
+
+    app = FastAPI()
+
+    @app.get("/error")
+    async def _error():
+        add_feature_flag("hello", False)
+
+        with sentry_sdk.start_span(name="test-span"):
+            with sentry_sdk.start_span(name="test-span-2"):
+                raise ValueError("something is wrong!")
+
+    try:
+        client = TestClient(app)
+        client.get("/error")
+    except ValueError:
+        pass
+
+    found = False
+    for event in events:
+        if "exception" in event.keys():
+            assert event["contexts"]["flags"] == {
+                "values": [
+                    {"flag": "hello", "result": False},
+                ]
+            }
+            found = True
+
+    assert found, "No event with exception found"

tests/test_basics.py

@@ -1151,14 +1151,12 @@ def recurse():
     (event,) = events
 
     assert event["exception"]["values"][0]["stacktrace"] is None
-    assert event["_meta"] == {
-        "exception": {
-            "values": {"0": {"stacktrace": {"": {"rem": [["!config", "x"]]}}}}
-        }
+    assert event["_meta"]["exception"] == {
+        "values": {"0": {"stacktrace": {"": {"rem": [["!config", "x"]]}}}}
     }
 
     # On my machine, it takes about 100-200ms to capture the exception,
     # so this limit should be generous enough.
     assert (
-        capture_end_time - capture_start_time < 10**9
+        capture_end_time - capture_start_time < 10**9 * 2
     ), "stacktrace capture took too long, check that frame limit is set correctly"