fix(celery): change out.host tags to point to celery broker [backport…

… 2.17] (#11540)

Backport b9573be from #10750 to 2.17.

## Motivation

Change `out.host` tags to point towards the celery broker, instead of
the local celery hostname. Fixes service-representation issues.

Fixes [11491](#11491)

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met 
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

---------

Co-authored-by: Zachary Groves <[email protected]>
Co-authored-by: William Conti <[email protected]>
Co-authored-by: William Conti <[email protected]>

.riot/requirements/1509aa1.txt

@@ -0,0 +1,35 @@
+#
+# This file is autogenerated by pip-compile with Python 3.12
+# by the following command:
+#
+#    pip-compile --allow-unsafe --no-annotate .riot/requirements/1509aa1.in
+#
+amqp==5.3.1
+attrs==24.2.0
+billiard==4.2.1
+celery[redis]==5.4.0
+click==8.1.7
+click-didyoumean==0.3.1
+click-plugins==1.1.1
+click-repl==0.3.0
+coverage[toml]==7.6.8
+hypothesis==6.45.0
+iniconfig==2.0.0
+kombu==5.4.2
+mock==5.1.0
+more-itertools==8.10.0
+opentracing==2.4.0
+packaging==24.2
+pluggy==1.5.0
+prompt-toolkit==3.0.48
+pytest==8.3.3
+pytest-cov==6.0.0
+pytest-mock==3.14.0
+pytest-randomly==3.16.0
+python-dateutil==2.9.0.post0
+redis==5.2.0
+six==1.16.0
+sortedcontainers==2.4.0
+tzdata==2024.2
+vine==5.1.0
+wcwidth==0.2.13

.riot/requirements/1df4aa0.txt

@@ -0,0 +1,35 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile --allow-unsafe --no-annotate .riot/requirements/1df4aa0.in
+#
+amqp==5.3.1
+attrs==24.2.0
+billiard==4.2.1
+celery[redis]==5.4.0
+click==8.1.7
+click-didyoumean==0.3.1
+click-plugins==1.1.1
+click-repl==0.3.0
+coverage[toml]==7.6.8
+hypothesis==6.45.0
+iniconfig==2.0.0
+kombu==5.4.2
+mock==5.1.0
+more-itertools==8.10.0
+opentracing==2.4.0
+packaging==24.2
+pluggy==1.5.0
+prompt-toolkit==3.0.48
+pytest==8.3.3
+pytest-cov==6.0.0
+pytest-mock==3.14.0
+pytest-randomly==3.16.0
+python-dateutil==2.9.0.post0
+redis==5.2.0
+six==1.16.0
+sortedcontainers==2.4.0
+tzdata==2024.2
+vine==5.1.0
+wcwidth==0.2.13

.riot/requirements/654f8c0.txt

@@ -0,0 +1,38 @@
+#
+# This file is autogenerated by pip-compile with Python 3.10
+# by the following command:
+#
+#    pip-compile --allow-unsafe --no-annotate .riot/requirements/654f8c0.in
+#
+amqp==5.3.1
+async-timeout==5.0.1
+attrs==24.2.0
+billiard==4.2.1
+celery[redis]==5.4.0
+click==8.1.7
+click-didyoumean==0.3.1
+click-plugins==1.1.1
+click-repl==0.3.0
+coverage[toml]==7.6.8
+exceptiongroup==1.2.2
+hypothesis==6.45.0
+iniconfig==2.0.0
+kombu==5.4.2
+mock==5.1.0
+more-itertools==8.10.0
+opentracing==2.4.0
+packaging==24.2
+pluggy==1.5.0
+prompt-toolkit==3.0.48
+pytest==8.3.3
+pytest-cov==6.0.0
+pytest-mock==3.14.0
+pytest-randomly==3.16.0
+python-dateutil==2.9.0.post0
+redis==5.2.0
+six==1.16.0
+sortedcontainers==2.4.0
+tomli==2.1.0
+tzdata==2024.2
+vine==5.1.0
+wcwidth==0.2.13

ddtrace/contrib/internal/celery/signals.py

@@ -1,5 +1,7 @@
+from urllib.parse import urlparse
+
+from celery import current_app
 from celery import registry
-from celery.utils import nodenames
 
 from ddtrace import Pin
 from ddtrace import config
@@ -167,9 +169,21 @@ def trace_after_publish(*args, **kwargs):
     if span is None:
         return
     else:
-        nodename = span.get_tag("celery.hostname")
-        if nodename is not None:
-            _, host = nodenames.nodesplit(nodename)
+        broker_url = current_app.conf.broker_url
+
+        if broker_url == "memory://":
+            host = broker_url
+        else:
+            parsed_url = urlparse(broker_url)
+
+            host = None
+            if parsed_url.hostname:
+                host = parsed_url.hostname
+
+            if parsed_url.port:
+                span.set_metric(net.TARGET_PORT, parsed_url.port)
+
+        if host:
             span.set_tag_str(net.TARGET_HOST, host)
 
         span.finish()

releasenotes/notes/update-celery-out-host-tag-be8da4f2ab88b4cf.yaml

@@ -0,0 +1,5 @@
+---
+fixes:
+  - |
+    celery: Changes celery ``out.host`` span tag to point towards broker host url instead of local celery process hostname. Fixes 
+    inferred service representation issues when using celery.

riotfile.py

@@ -716,10 +716,9 @@ def select_pys(min_version: str = MIN_PYTHON_VERSION, max_version: str = MAX_PYT
                         "PYTEST_PLUGINS": "celery.contrib.pytest",
                     },
                     pkgs={
-                        "celery": [
+                        "celery[redis]": [
                             latest,
                         ],
-                        "redis": "~=3.5",
                     },
                 ),
             ],

tests/contrib/celery/base.py

@@ -8,13 +8,19 @@
 from ddtrace.contrib.celery import unpatch
 from tests.utils import TracerTestCase
 
+from ..config import RABBITMQ_CONFIG
 from ..config import REDIS_CONFIG
 
 
 REDIS_URL = "redis://127.0.0.1:{port}".format(port=REDIS_CONFIG["port"])
 BROKER_URL = "{redis}/{db}".format(redis=REDIS_URL, db=0)
 BACKEND_URL = "{redis}/{db}".format(redis=REDIS_URL, db=1)
 
+AMQP_URL = "amqp://{user}:{password}@127.0.0.1:{port}".format(
+    user=RABBITMQ_CONFIG["user"], password=RABBITMQ_CONFIG["password"], port=RABBITMQ_CONFIG["port"]
+)
+AMQP_BROKER_URL = "{amqp}//".format(amqp=AMQP_URL)
+
 
 @pytest.fixture(scope="session")
 def celery_config():

tests/contrib/celery/test_integration.py

@@ -1,6 +1,5 @@
 from collections import Counter
 import os
-import socket
 import subprocess
 from time import sleep
 
@@ -194,7 +193,7 @@ def fn_task_parameters(user, force_logout=False):
             assert async_span.get_tag("celery.routing_key") == "celery"
             assert async_span.get_tag("component") == "celery"
             assert async_span.get_tag("span.kind") == "producer"
-            assert async_span.get_tag("out.host") == socket.gethostname()
+            assert async_span.get_tag("out.host") == "memory://"
         else:
             assert 1 == len(traces)
             assert 1 == len(traces[0])
@@ -239,7 +238,7 @@ def fn_task_parameters(user, force_logout=False):
             assert async_span.get_tag("celery.routing_key") == "celery"
             assert async_span.get_tag("component") == "celery"
             assert async_span.get_tag("span.kind") == "producer"
-            assert async_span.get_tag("out.host") == socket.gethostname()
+            assert async_span.get_tag("out.host") == "memory://"
         else:
             assert 1 == len(traces)
             assert 1 == len(traces[0])
@@ -600,7 +599,7 @@ def fn_task_parameters(user, force_logout=False):
             assert async_span.get_tag("celery.routing_key") == "celery"
             assert async_span.get_tag("component") == "celery"
             assert async_span.get_tag("span.kind") == "producer"
-            assert async_span.get_tag("out.host") == socket.gethostname()
+            assert async_span.get_tag("out.host") == "memory://"
 
         run_span = self.find_span(name="celery.run")
         assert run_span.name == "celery.run"