fix(Ray): Retain the original function name when patching Ray tasks (#4858)

### Description

Without "@functools.wraps" added, Ray exposes Prometheus metrics with
all tasks named "new_func"

#### Issues

* Follow up to
[!4430](#4430) comments

#### Reminders
- Please add tests to validate your changes, and lint your code using
`tox -e linters`.
- Add GH Issue ID _&_ Linear ID (if applicable)
- PR title should use [conventional
commit](https://develop.sentry.dev/engineering-practices/commit-messages/#type)
style (`feat:`, `fix:`, `ref:`, `meta:`)
- For external contributors:
[CONTRIBUTING.md](https://github.com/getsentry/sentry-python/blob/master/CONTRIBUTING.md),
[Sentry SDK development docs](https://develop.sentry.dev/sdk/), [Discord
community](https://discord.gg/Ww9hbqr)

Author: svartalf

sentry_sdk/integrations/ray.py

@@ -1,4 +1,5 @@
 import inspect
+import functools
 import sys
 
 import sentry_sdk
@@ -17,7 +18,6 @@
     import ray  # type: ignore[import-not-found]
 except ImportError:
     raise DidNotEnable("Ray not installed.")
-import functools
 
 from typing import TYPE_CHECKING
 
@@ -54,12 +54,13 @@ def new_remote(f=None, *args, **kwargs):
 
         def wrapper(user_f):
             # type: (Callable[..., Any]) -> Any
-            def new_func(*f_args, _tracing=None, **f_kwargs):
+            @functools.wraps(user_f)
+            def new_func(*f_args, _sentry_tracing=None, **f_kwargs):
                 # type: (Any, Optional[dict[str, Any]], Any) -> Any
                 _check_sentry_initialized()
 
                 transaction = sentry_sdk.continue_trace(
-                    _tracing or {},
+                    _sentry_tracing or {},
                     op=OP.QUEUE_TASK_RAY,
                     name=qualname_from_function(user_f),
                     origin=RayIntegration.origin,
@@ -78,6 +79,19 @@ def new_func(*f_args, _tracing=None, **f_kwargs):
 
                     return result
 
+            # Patching new_func signature to add the _sentry_tracing parameter to it
+            # Ray later inspects the signature and finds the unexpected parameter otherwise
+            signature = inspect.signature(new_func)
+            params = list(signature.parameters.values())
+            params.append(
+                inspect.Parameter(
+                    "_sentry_tracing",
+                    kind=inspect.Parameter.KEYWORD_ONLY,
+                    default=None,
+                )
+            )
+            new_func.__signature__ = signature.replace(parameters=params)  # type: ignore[attr-defined]
+
             if f:
                 rv = old_remote(new_func)
             else:
@@ -99,7 +113,9 @@ def _remote_method_with_header_propagation(*args, **kwargs):
                         for k, v in sentry_sdk.get_current_scope().iter_trace_propagation_headers()
                     }
                     try:
-                        result = old_remote_method(*args, **kwargs, _tracing=tracing)
+                        result = old_remote_method(
+                            *args, **kwargs, _sentry_tracing=tracing
+                        )
                         span.set_status(SPANSTATUS.OK)
                     except Exception:
                         span.set_status(SPANSTATUS.INTERNAL_ERROR)

tests/integrations/ray/test_ray.py

@@ -100,6 +100,9 @@ def example_task():
     else:
         example_task = ray.remote(example_task)
 
+    # Function name shouldn't be overwritten by Sentry wrapper
+    assert example_task._function_name == "tests.integrations.ray.test_ray.example_task"
+
     with sentry_sdk.start_transaction(op="task", name="ray test transaction"):
         worker_envelopes = ray.get(example_task.remote())