adjust

Author: sentrivana

MIGRATION_GUIDE.md

@@ -20,18 +20,18 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
 - Redis integration: In Redis pipeline spans there is no `span["data"]["redis.commands"]` that contains a dict `{"count": 3, "first_ten": ["cmd1", "cmd2", ...]}` but instead `span["data"]["redis.commands.count"]` (containing `3`) and `span["data"]["redis.commands.first_ten"]` (containing `["cmd1", "cmd2", ...]`).
 - clickhouse-driver integration: The query is now available under the `db.query.text` span attribute (only if `send_default_pii` is `True`).
 - `sentry_sdk.init` now returns `None` instead of a context manager.
-- The `sampling_context` argument of `traces_sampler` now additionally contains all span attributes known at span start.
-- If you're using the Celery integration, the `sampling_context` argument of `traces_sampler` doesn't contain the `celery_job` dictionary anymore. Instead, the individual keys are now available as:
+- The `sampling_context` argument of `traces_sampler` and `profiles_sampler` now additionally contains all span attributes known at span start.
+- If you're using the Celery integration and a custom traces/profiles sampler, the `sampling_context` argument of `traces_sampler` and `profiles_sampler` doesn't contain the `celery_job` dictionary anymore. Instead, the individual keys are now available as:
 
-  | Dictionary keys        | Sampling context key |
-  | ---------------------- | -------------------- |
-  | `celery_job["args"]`   | `celery.job.args`    |
-  | `celery_job["kwargs"]` | `celery.job.kwargs`  |
-  | `celery_job["task"]`   | `celery.job.task`    |
+  | Dictionary keys        | Sampling context key        | Example                        |
+  | ---------------------- | --------------------------- | ------------------------------ |
+  | `celery_job["args"]`   | `celery.job.args.{index}`   | `celery.job.args.0`            |
+  | `celery_job["kwargs"]` | `celery.job.kwargs.{kwarg}` | `celery.job.kwargs.kwarg_name` |
+  | `celery_job["task"]`   | `celery.job.task`           |                                |
 
   Note that all of these are serialized, i.e., not the original `args` and `kwargs` but rather OpenTelemetry-friendly span attributes.
 
-- If you're using the AIOHTTP integration, the `sampling_context` argument of `traces_sampler` doesn't contain the `aiohttp_request` object anymore. Instead, some of the individual properties of the request are accessible, if available, as follows:
+- If you're using the AIOHTTP integration and a custom traces/profiles sampler, the `sampling_context` argument of `traces_sampler` and `profiles_sampler` doesn't contain the `aiohttp_request` object anymore. Instead, some of the individual properties of the request are accessible, if available, as follows:
 
   | Request property | Sampling context key(s)         |
   | ---------------- | ------------------------------- |
@@ -42,7 +42,7 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
   | `scheme`         | `url.scheme`                    |
   | full URL         | `url.full`                      |
 
-- If you're using the Tornado integration, the `sampling_context` argument of `traces_sampler` doesn't contain the `tornado_request` object anymore. Instead, some of the individual properties of the request are accessible, if available, as follows:
+- If you're using the Tornado integration and a custom traces/profiles sampler, the `sampling_context` argument of `traces_sampler` and `profiles_sampler` doesn't contain the `tornado_request` object anymore. Instead, some of the individual properties of the request are accessible, if available, as follows:
 
   | Request property | Sampling context key(s)                             |
   | ---------------- | --------------------------------------------------- |
@@ -54,7 +54,7 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
   | `version`        | `network.protocol.name`, `network.protocol.version` |
   | full URL         | `url.full`                                          |
 
-- If you're using the generic WSGI integration, the `sampling_context` argument of `traces_sampler` doesn't contain the `wsgi_environ` object anymore. Instead, the individual properties of the environment are accessible, if available, as follows:
+- If you're using the generic WSGI integration and a custom traces/profiles sampler, the `sampling_context` argument of `traces_sampler` and `profiles_sampler` doesn't contain the `wsgi_environ` object anymore. Instead, the individual properties of the environment are accessible, if available, as follows:
 
   | Env property      | Sampling context key(s)                           |
   | ----------------- | ------------------------------------------------- |
@@ -67,7 +67,7 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
   | `wsgi.url_scheme` | `url.scheme`                                      |
   | full URL          | `url.full`                                        |
 
-- If you're using the generic ASGI integration, the `sampling_context` argument of `traces_sampler` doesn't contain the `asgi_scope` object anymore. Instead, the individual properties of the scope, if available, are accessible as follows:
+- If you're using the generic ASGI integration and a custom traces/profiles sampler, the `sampling_context` argument of `traces_sampler` and `profiles_sampler` doesn't contain the `asgi_scope` object anymore. Instead, the individual properties of the scope, if available, are accessible as follows:
 
   | Scope property | Sampling context key(s)         |
   | -------------- | ------------------------------- |
@@ -81,19 +81,19 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
   | `client`       | `client.address`, `client.port` |
   | full URL       | `url.full`                      |
 
-- If you're using the RQ integration, the `sampling_context` argument of `traces_sampler` doesn't contain the `rq_job` object anymore. Instead, the individual properties of the job and the queue, if available, are accessible as follows:
+- If you're using the RQ integration and a custom traces/profiles sampler, the `sampling_context` argument of `traces_sampler` and `profiles_sampler` doesn't contain the `rq_job` object anymore. Instead, the individual properties of the job and the queue, if available, are accessible as follows:
 
-  | RQ property     | Sampling context key(s)      |
-  | --------------- | ---------------------------- |
-  | `rq_job.args`   | `rq.job.args`                |
-  | `rq_job.kwargs` | `rq.job.kwargs`              |
-  | `rq_job.func`   | `rq.job.func`                |
-  | `queue.name`    | `messaging.destination.name` |
-  | `rq_job.id`     | `messaging.message.id`       |
+  | RQ property     | Sampling context key         | Example                |
+  | --------------- | ---------------------------- | ---------------------- |
+  | `rq_job.args`   | `rq.job.args.{index}`        | `rq.job.args.0`        |
+  | `rq_job.kwargs` | `rq.job.kwargs.{kwarg}`      | `rq.job.args.my_kwarg` |
+  | `rq_job.func`   | `rq.job.func`                |                        |
+  | `queue.name`    | `messaging.destination.name` |                        |
+  | `rq_job.id`     | `messaging.message.id`       |                        |
 
   Note that `rq.job.args`, `rq.job.kwargs`, and `rq.job.func` are serialized and not the actual objects on the job.
 
-- If you're using the AWS Lambda integration, the `sampling_context` argument of `traces_sampler` doesn't contain the `aws_event` and `aws_context` objects anymore. Instead, the following, if available, is accessible:
+- If you're using the AWS Lambda integration and a custom traces/profiles sampler, the `sampling_context` argument of `traces_sampler` and `profiles_sampler` doesn't contain the `aws_event` and `aws_context` objects anymore. Instead, the following, if available, is accessible:
 
   | AWS property                                | Sampling context key(s) |
   | ------------------------------------------- | ----------------------- |
@@ -105,7 +105,7 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
   | `aws_event["headers"]["Host"]`              | `server.address`        |
   | `aws_context["function_name"]`              | `faas.name`             |
 
-- If you're using the GCP integration, the `sampling_context` argument of `traces_sampler` doesn't contain the `gcp_env` and `gcp_event` keys anymore. Instead, the following, if available, is accessible:
+- If you're using the GCP integration and a custom traces/profiles sampler, the `sampling_context` argument of `traces_sampler` and `profiles_sampler` doesn't contain the `gcp_env` and `gcp_event` keys anymore. Instead, the following, if available, is accessible:
 
   | Old sampling context key          | New sampling context key   |
   | --------------------------------- | -------------------------- |

sentry_sdk/integrations/celery/__init__.py

@@ -20,7 +20,6 @@
     ensure_integration_enabled,
     event_from_exception,
     reraise,
-    _serialize_span_attribute,
 )
 
 from typing import TYPE_CHECKING
@@ -517,7 +516,14 @@ def _prepopulate_attributes(task, args, kwargs):
     # type: (Any, *Any, **Any) -> dict[str, str]
     attributes = {
         "celery.job.task": task.name,
-        "celery.job.args": _serialize_span_attribute(args),
-        "celery.job.kwargs": _serialize_span_attribute(kwargs),
     }
+
+    for i, arg in enumerate(args):
+        with capture_internal_exceptions():
+            attributes[f"celery.job.args.{i}"] = str(arg)
+
+    for kwarg, value in kwargs.items():
+        with capture_internal_exceptions():
+            attributes[f"celery.job.kwargs.{kwarg}"] = str(value)
+
     return attributes

sentry_sdk/integrations/rq.py

@@ -6,7 +6,6 @@
 from sentry_sdk.integrations.logging import ignore_logger
 from sentry_sdk.tracing import TRANSACTION_SOURCE_TASK
 from sentry_sdk.utils import (
-    _serialize_span_attribute,
     capture_internal_exceptions,
     ensure_integration_enabled,
     event_from_exception,
@@ -183,6 +182,7 @@ def _prepopulate_attributes(job, queue):
     # type: (Job, Queue) -> dict[str, Any]
     attributes = {
         "messaging.system": "rq",
+        "rq.job.id": job.id,
     }
 
     for prop, attr in JOB_PROPERTY_TO_ATTRIBUTE.items():
@@ -193,14 +193,20 @@ def _prepopulate_attributes(job, queue):
         if getattr(queue, prop, None) is not None:
             attributes[attr] = getattr(queue, prop)
 
-    for key in ("args", "kwargs"):
-        if getattr(job, key, None):
-            attributes[f"rq.job.{key}"] = _serialize_span_attribute(getattr(job, key))
+    if getattr(job, "args", None):
+        for i, arg in enumerate(job.args):
+            with capture_internal_exceptions():
+                attributes[f"rq.job.args.{i}"] = str(arg)
+
+    if getattr(job, "kwargs", None):
+        for kwarg, value in job.kwargs.items():
+            with capture_internal_exceptions():
+                attributes[f"rq.job.kwargs.{kwarg}"] = str(value)
 
     func = job.func
     if callable(func):
         func = func.__name__
 
-    attributes["rq.job.func"] = _serialize_span_attribute(func)
+    attributes["rq.job.func"] = str(func)
 
     return attributes

tests/integrations/celery/test_celery.py

@@ -13,7 +13,6 @@
     _wrap_task_run,
 )
 from sentry_sdk.integrations.celery.beat import _get_headers
-from sentry_sdk.utils import _serialize_span_attribute
 from tests.conftest import ApproxDict
 
 
@@ -448,12 +447,10 @@ def walk_dogs(x, y):
 
     sampling_context = traces_sampler.call_args_list[1][0][0]
     assert sampling_context["celery.job.task"] == "dog_walk"
-    assert sampling_context["celery.job.args"] == _serialize_span_attribute(
-        args_kwargs["args"]
-    )
-    assert sampling_context["celery.job.kwargs"] == _serialize_span_attribute(
-        args_kwargs["kwargs"]
-    )
+    for i, arg in enumerate(args_kwargs["args"]):
+        assert sampling_context[f"celery.job.args.{i}"] == str(arg)
+    for kwarg, value in args_kwargs["kwargs"].items():
+        assert sampling_context[f"celery.job.kwargs.{kwarg}"] == str(value)
 
 
 def test_abstract_task(capture_events, celery, celery_invocation):

tests/integrations/rq/test_rq.py

@@ -227,13 +227,23 @@ def test_traces_sampler_gets_correct_values_in_sampling_context(sentry_init):
     queue = rq.Queue(connection=FakeStrictRedis())
     worker = rq.SimpleWorker([queue], connection=queue.connection)
 
-    queue.enqueue(do_trick, "Bodhi", trick="roll over")
+    queue.enqueue(
+        do_trick,
+        "Bodhi",
+        {"age": 5},
+        trick="roll over",
+        times=2,
+        followup=["fetch", "give paw"],
+    )
     worker.work(burst=True)
 
     sampling_context = traces_sampler.call_args_list[0][0][0]
     assert sampling_context["messaging.system"] == "rq"
-    assert sampling_context["rq.job.args"] == ["Bodhi"]
-    assert sampling_context["rq.job.kwargs"] == '{"trick": "roll over"}'
+    assert sampling_context["rq.job.args.0"] == "Bodhi"
+    assert sampling_context["rq.job.args.1"] == "{'age': 5}"
+    assert sampling_context["rq.job.kwargs.trick"] == "roll over"
+    assert sampling_context["rq.job.kwargs.times"] == "2"
+    assert sampling_context["rq.job.kwargs.followup"] == "['fetch', 'give paw']"
     assert sampling_context["rq.job.func"] == "do_trick"
     assert sampling_context["messaging.message.id"]
     assert sampling_context["messaging.destination.name"] == "default"