feat: Add scope.set_attribute

Author: sentrivana

sentry_sdk/scope.py

@@ -46,6 +46,7 @@
     disable_capture_event,
     event_from_exception,
     exc_info_from_error,
+    format_attribute,
     logger,
     has_logs_enabled,
     has_metrics_enabled,
@@ -73,6 +74,8 @@
     from typing_extensions import Unpack
 
     from sentry_sdk._types import (
+        Attributes,
+        AttributeValue,
         Breadcrumb,
         BreadcrumbHint,
         ErrorProcessor,
@@ -230,6 +233,7 @@ class Scope:
         "_type",
         "_last_event_id",
         "_flags",
+        "_attributes",
     )
 
     def __init__(
@@ -296,6 +300,8 @@ def __copy__(self) -> "Scope":
 
         rv._flags = deepcopy(self._flags)
 
+        rv._attributes = self._attributes.copy()
+
         return rv
 
     @classmethod
@@ -684,6 +690,8 @@ def clear(self) -> None:
         self._last_event_id: "Optional[str]" = None
         self._flags: "Optional[FlagBuffer]" = None
 
+        self._attributes: "Attributes" = {}
+
     @_attr_setter
     def level(self, value: "LogLevelStr") -> None:
         """
@@ -1487,6 +1495,14 @@ def _apply_global_attributes_to_telemetry(
         if release is not None and "sentry.release" not in attributes:
             attributes["sentry.release"] = release
 
+    def _apply_scope_attributes_to_telemetry(
+        self, telemetry: "Union[Log, Metric]"
+    ) -> None:
+        attributes = telemetry["attributes"]
+
+        for attribute, value in self._attributes.items():
+            attributes[attribute] = value
+
     def _apply_user_attributes_to_telemetry(
         self, telemetry: "Union[Log, Metric]"
     ) -> None:
@@ -1622,6 +1638,7 @@ def apply_to_telemetry(self, telemetry: "Union[Log, Metric]") -> None:
             telemetry["span_id"] = span_id
 
         self._apply_global_attributes_to_telemetry(telemetry)
+        self._apply_scope_attributes_to_telemetry(telemetry)
         self._apply_user_attributes_to_telemetry(telemetry)
 
     def update_from_scope(self, scope: "Scope") -> None:
@@ -1668,6 +1685,8 @@ def update_from_scope(self, scope: "Scope") -> None:
             else:
                 for flag in scope._flags.get():
                     self._flags.set(flag["flag"], flag["result"])
+        if scope._attributes:
+            self._attributes.update(scope._attributes)
 
     def update_from_kwargs(
         self,
@@ -1677,6 +1696,7 @@ def update_from_kwargs(
         contexts: "Optional[Dict[str, Dict[str, Any]]]" = None,
         tags: "Optional[Dict[str, str]]" = None,
         fingerprint: "Optional[List[str]]" = None,
+        attributes: "Optional[Attributes]" = None,
     ) -> None:
         """Update the scope's attributes."""
         if level is not None:
@@ -1691,6 +1711,8 @@ def update_from_kwargs(
             self._tags.update(tags)
         if fingerprint is not None:
             self._fingerprint = fingerprint
+        if attributes is not None:
+            self._attributes.update(attributes)
 
     def __repr__(self) -> str:
         return "<%s id=%s name=%s type=%s>" % (
@@ -1710,6 +1732,15 @@ def flags(self) -> "FlagBuffer":
             self._flags = FlagBuffer(capacity=max_flags)
         return self._flags
 
+    def set_attribute(self, attribute: str, value: "AttributeValue") -> None:
+        self._attributes[attribute] = format_attribute(value)
+
+    def remove_attribute(self, attribute: str) -> None:
+        try:
+            del self._attributes[attribute]
+        except KeyError:
+            pass
+
 
 @contextmanager
 def new_scope() -> "Generator[Scope, None, None]":

sentry_sdk/utils.py

@@ -2047,7 +2047,25 @@ def get_before_send_metric(
     )
 
 
+def format_attribute(val: "Any") -> "AttributeValue":
+    """
+    Turn unsupported attribute value types into an AttributeValue.
+
+    We do this as soon as a user-provided attribute is set, to prevent spans,
+    logs, ßmetrics and similar from having live references to various ßobjects.
+
+    Note: This is not the final attribute value format. Before they're sent,
+    they're serialized further into the actual format the protocol expects:
+    https://develop.sentry.dev/sdk/telemetry/attributes/
+    """
+    if isinstance(val, (bool, int, float, str)):
+        return val
+
+    return safe_repr(val)
+
+
 def serialize_attribute(val: "AttributeValue") -> "SerializedAttributeValue":
+    """Serialize attribute value to the transport format."""
     if isinstance(val, bool):
         return {"value": val, "type": "boolean"}
     if isinstance(val, int):
@@ -2057,5 +2075,6 @@ def serialize_attribute(val: "AttributeValue") -> "SerializedAttributeValue":
     if isinstance(val, str):
         return {"value": val, "type": "string"}
 
-    # Coerce to string if we don't know what to do with the value
+    # Coerce to string if we don't know what to do with the value. This should
+    # never happen as we pre-format early in format_attribute, but let's be safe.
     return {"value": safe_repr(val), "type": "string"}

tests/test_logs.py

@@ -548,3 +548,50 @@ def record_lost_event(reason, data_category=None, item=None, *, quantity=1):
                 }
             ]
         }
+
+
+def test_log_gets_attributes_from_scopes(sentry_init, capture_envelopes):
+    sentry_init(enable_logs=True)
+
+    envelopes = capture_envelopes()
+
+    global_scope = sentry_sdk.get_global_scope()
+    global_scope.set_attribute("global.attribute", "value")
+
+    with sentry_sdk.new_scope() as scope:
+        scope.set_attribute("current.attribute", "value")
+        python_logger = logging.Logger("test-logger")
+        python_logger.warning("Hello, world!")
+
+    python_logger.warning("Hello, world!")
+
+    get_client().flush()
+
+    logs = envelopes_to_logs(envelopes)
+    (log1, log2) = logs
+
+    assert log1["attributes"]["global.attribute"] == "value"
+    assert log1["attributes"]["current.attribute"] == "value"
+
+    assert log2["attributes"]["temp.attribute"] == "value"
+    assert "current.attribute" not in log2["attributes"]
+
+
+def test_log_attributes_override_scope_attributes(sentry_init, capture_envelopes):
+    sentry_init(enable_logs=True)
+
+    envelopes = capture_envelopes()
+
+    with sentry_sdk.new_scope() as scope:
+        scope.set_attribute("durable.attribute", "value1")
+        scope.set_attribute("temp.attribute", "value1")
+        python_logger = logging.Logger("test-logger")
+        python_logger.warning("Hello, world!", attributes={"temp.attribute": "value2"})
+
+    get_client().flush()
+
+    logs = envelopes_to_logs(envelopes)
+    (log,) = logs
+
+    assert log["attributes"]["durable.attribute"] == "value1"
+    assert log["attributes"]["temp.attribute"] == "value2"

tests/test_metrics.py

@@ -290,3 +290,48 @@ def record_lost_event(reason, data_category, quantity):
     assert len(lost_event_calls) == 5
     for lost_event_call in lost_event_calls:
         assert lost_event_call == ("queue_overflow", "trace_metric", 1)
+
+
+def test_metric_gets_attributes_from_scopes(sentry_init, capture_envelopes):
+    sentry_init()
+
+    envelopes = capture_envelopes()
+
+    global_scope = sentry_sdk.get_global_scope()
+    global_scope.set_attribute("global.attribute", "value")
+
+    with sentry_sdk.new_scope() as scope:
+        scope.set_attribute("current.attribute", "value")
+        sentry_sdk.metrics.count("test", 1)
+
+    sentry_sdk.metrics.count("test", 1)
+
+    get_client().flush()
+
+    metrics = envelopes_to_metrics(envelopes)
+    (metric1, metric2) = metrics
+
+    assert metric1["attributes"]["global.attribute"] == "value"
+    assert metric1["attributes"]["current.attribute"] == "value"
+
+    assert metric2["attributes"]["temp.attribute"] == "value"
+    assert "current.attribute" not in metric2["attributes"]
+
+
+def test_metric_attributes_override_scope_attributes(sentry_init, capture_envelopes):
+    sentry_init()
+
+    envelopes = capture_envelopes()
+
+    with sentry_sdk.new_scope() as scope:
+        scope.set_attribute("durable.attribute", "value1")
+        scope.set_attribute("temp.attribute", "value1")
+        sentry_sdk.metrics.count("test", 1)
+
+    get_client().flush()
+
+    metrics = envelopes_to_metrics(envelopes)
+    (metric,) = metrics
+
+    assert metric["attributes"]["durable.attribute"] == "value1"
+    assert metric["attributes"]["temp.attribute"] == "value2"