revert(tracing/internal): disable Datadog internal tag propagation (#3326) (#3329)

(cherry picked from commit 99b9fac)

Co-authored-by: Brett Langdon <[email protected]>

Author: mergify[bot]

benchmarks/http_propagation_extract/config.yaml

@@ -26,7 +26,7 @@ valid_headers_basic: &valid_headers_basic
 valid_headers_all: &valid_headers_all
   <<: *default_values
   headers: |
-    {"x-datadog-trace-id": "1234", "x-datadog-span-id": "5678", "x-datadog-sampling-priority": "1", "x-datadog-origin": "synthetics", "x-datadog-tags": "_dd.p.tag=value,_dd.p.some_long_key=some_long_value"}
+    {"x-datadog-trace-id": "1234", "x-datadog-span-id": "5678", "x-datadog-sampling-priority": "1", "x-datadog-origin": "synthetics"}
 
 # All valid/possible headers but 20 additional unrelated headers
 medium_valid_headers_all: &medium_valid_headers_all
@@ -42,25 +42,19 @@ large_valid_headers_all: &large_valid_headers_all
 invalid_trace_id_header: &invalid_trace_id_header
   <<: *default_values
   headers: |
-    {"x-datadog-trace-id": "trace_id", "x-datadog-span-id": "5678", "x-datadog-sampling-priority": "1", "x-datadog-origin": "synthetics", "x-datadog-tags": "_dd.p.tag=value,_dd.p.some_long_key=some_long_value"}
+    {"x-datadog-trace-id": "trace_id", "x-datadog-span-id": "5678", "x-datadog-sampling-priority": "1", "x-datadog-origin": "synthetics"}
 
 # x-datadog-span-id is invalid
 invalid_span_id_header: &invalid_span_id_header
   <<: *default_values
   headers: |
-    {"x-datadog-trace-id": "1234", "x-datadog-span-id": "span_id", "x-datadog-sampling-priority": "1", "x-datadog-origin": "synthetics", "x-datadog-tags": "_dd.p.tag=value,_dd.p.some_long_key=some_long_value"}
+    {"x-datadog-trace-id": "1234", "x-datadog-span-id": "span_id", "x-datadog-sampling-priority": "1", "x-datadog-origin": "synthetics"}
 
 # x-datadog-sampling-priority is invalid
 invalid_priority_header: &invalid_priority_header
   <<: *default_values
   headers: |
-    {"x-datadog-trace-id": "1234", "x-datadog-span-id": "5678", "x-datadog-sampling-priority": "priority", "x-datadog-origin": "synthetics", "x-datadog-tags": "_dd.p.tag=value,_dd.p.some_long_key=some_long_value"}
-
-# x-datadog-tags is invalid
-invalid_tags_header: &invalid_tags_header
-  <<: *default_values
-  headers: |
-    {"x-datadog-trace-id": "1234", "x-datadog-span-id": "5678", "x-datadog-sampling-priority": "1", "x-datadog-origin": "synthetics", "x-datadog-tags": "_dd.p.tag=value,_dd.p.some_long_key=some_long_value,key=,=value,"}
+    {"x-datadog-trace-id": "1234", "x-datadog-span-id": "5678", "x-datadog-sampling-priority": "priority", "x-datadog-origin": "synthetics"}
 
 
 # Same scenarios as above but with HTTP_WSGI_STYLE_HEADERS
@@ -103,7 +97,3 @@ wsgi_invalid_span_id_header:
 wsgi_invalid_priority_header:
   <<: *invalid_priority_header
   wsgi_style: True
-
-wsgi_invalid_tags_header:
-  <<: *invalid_tags_header
-  wsgi_style: True

benchmarks/http_propagation_extract/scenario.py

@@ -2,8 +2,8 @@
 
 import bm
 
+from ddtrace.propagation import _utils as utils
 from ddtrace.propagation import http
-from ddtrace.propagation import utils
 
 
 class HTTPPropagationExtract(bm.Scenario):

benchmarks/http_propagation_inject/config.yaml

@@ -1,7 +1,6 @@
 ids_only: &defaults
   sampling_priority: ""
   dd_origin: ""
-  meta: ""
 
 with_sampling_priority:
   <<: *defaults
@@ -16,25 +15,3 @@ with_priority_and_origin:
   sampling_priority: "1"
   dd_origin: "synthetics"
 
-with_tags:
-  <<: *defaults
-  meta: |
-    {"_dd.p.test": "value", "_dd.p.sample": "value", "will.be": "skipped"}
-
-with_all:
-  <<: *defaults
-  sampling_priority: "1"
-  dd_origin: "synthetics"
-  meta: |
-    {"_dd.p.test": "value", "_dd.p.sample": "value", "will.be": "skipped"}
-
-with_tags_invalid:
-  <<: *defaults
-  meta: |
-    {"_dd.p.test": "value", "_dd.p.test=": "=value,"}
-
-with_tags_max_size:
-  <<: *defaults
-  # The limit is 512, so one of these will can be encoded, but not both
-  meta: |
-    {"_dd.p.test": "______________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________", "_dd.p.sample": "______________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________"}

benchmarks/http_propagation_inject/scenario.py

@@ -1,5 +1,3 @@
-import json
-
 import bm
 
 from ddtrace.context import Context
@@ -9,24 +7,18 @@
 class HTTPPropagationInject(bm.Scenario):
     sampling_priority = bm.var(type=str)
     dd_origin = bm.var(type=str)
-    meta = bm.var(type=str)
 
     def run(self):
         sampling_priority = None
         if self.sampling_priority != "":
             sampling_priority = int(self.sampling_priority)
         dd_origin = self.dd_origin or None
 
-        meta = None
-        if self.meta:
-            meta = json.loads(self.meta)
-
         ctx = Context(
             trace_id=8336172473188639332,
             span_id=6804240797025004118,
             sampling_priority=sampling_priority,
             dd_origin=dd_origin,
-            meta=meta,
         )
 
         def _(loops):

ddtrace/propagation/http.py

@@ -1,16 +1,8 @@
 from typing import Dict
 from typing import FrozenSet
 from typing import Optional
-from typing import Union
-from typing import cast
 
 from ..context import Context
-from ..internal._tagset import TagsetDecodeError
-from ..internal._tagset import TagsetEncodeError
-from ..internal._tagset import TagsetMaxSizeError
-from ..internal._tagset import decode_tagset_string
-from ..internal._tagset import encode_tagset_values
-from ..internal.compat import ensure_str
 from ..internal.logger import get_logger
 from ._utils import get_wsgi_header
 
@@ -23,7 +15,6 @@
 HTTP_HEADER_PARENT_ID = "x-datadog-parent-id"
 HTTP_HEADER_SAMPLING_PRIORITY = "x-datadog-sampling-priority"
 HTTP_HEADER_ORIGIN = "x-datadog-origin"
-HTTP_HEADER_TAGS = "x-datadog-tags"
 
 
 # Note that due to WSGI spec we have to also check for uppercased and prefixed
@@ -34,7 +25,6 @@
     [HTTP_HEADER_SAMPLING_PRIORITY, get_wsgi_header(HTTP_HEADER_SAMPLING_PRIORITY).lower()]
 )
 POSSIBLE_HTTP_HEADER_ORIGIN = frozenset([HTTP_HEADER_ORIGIN, get_wsgi_header(HTTP_HEADER_ORIGIN).lower()])
-POSSIBLE_HTTP_HEADER_TAGS = frozenset([HTTP_HEADER_TAGS, get_wsgi_header(HTTP_HEADER_TAGS).lower()])
 
 
 class HTTPPropagator(object):
@@ -74,30 +64,6 @@ def parent_call():
         if "_dd.propagation_error" in span_context._meta:
             return
 
-        # Only propagate tags that start with `_dd.p.`
-        tags_to_encode = {}  # type: Dict[str, str]
-        for key, value in span_context._meta.items():
-            # DEV: encoding will fail if the key or value are not `str`
-            key = ensure_str(key)
-            if key.startswith("_dd.p."):
-                tags_to_encode[key] = ensure_str(value)
-
-        if tags_to_encode:
-            encoded_tags = None
-
-            try:
-                encoded_tags = encode_tagset_values(tags_to_encode)
-            except TagsetMaxSizeError:
-                # We hit the max size allowed, add a tag to the context to indicate this happened
-                span_context._meta["_dd.propagation_error"] = "max_size"
-                log.warning("failed to encode x-datadog-tags", exc_info=True)
-            except TagsetEncodeError:
-                # We hit an encoding error, add a tag to the context to indicate this happened
-                span_context._meta["_dd.propagation_error"] = "encoding_error"
-                log.warning("failed to encode x-datadog-tags", exc_info=True)
-            if encoded_tags:
-                headers[HTTP_HEADER_TAGS] = encoded_tags
-
     @staticmethod
     def _extract_header_value(possible_header_names, headers, default=None):
         # type: (FrozenSet[str], Dict[str, str], Optional[str]) -> Optional[str]
@@ -155,19 +121,6 @@ def my_controller(url, headers):
                 POSSIBLE_HTTP_HEADER_ORIGIN,
                 normalized_headers,
             )
-            meta = None
-            tags_value = HTTPPropagator._extract_header_value(
-                POSSIBLE_HTTP_HEADER_TAGS,
-                normalized_headers,
-                default="",
-            )
-            if tags_value:
-                # Do not fail if the tags are malformed
-                try:
-                    # We get a Dict[str, str], but need it to be Dict[Union[str, bytes], str] (e.g. _MetaDictType)
-                    meta = cast(Dict[Union[str, bytes], str], decode_tagset_string(tags_value))
-                except TagsetDecodeError:
-                    log.debug("failed to decode x-datadog-tags: %r", tags_value, exc_info=True)
 
             # Try to parse values into their expected types
             try:
@@ -182,20 +135,15 @@ def my_controller(url, headers):
                     span_id=int(parent_span_id) or None,  # type: ignore[arg-type]
                     sampling_priority=sampling_priority,  # type: ignore[arg-type]
                     dd_origin=origin,
-                    meta=meta,
                 )
             # If headers are invalid and cannot be parsed, return a new context and log the issue.
             except (TypeError, ValueError):
                 log.debug(
-                    (
-                        "received invalid x-datadog-* headers, "
-                        "trace-id: %r, parent-id: %r, priority: %r, origin: %r, tags: %r"
-                    ),
+                    "received invalid x-datadog-* headers, " "trace-id: %r, parent-id: %r, priority: %r, origin: %r",
                     trace_id,
                     parent_span_id,
                     sampling_priority,
                     origin,
-                    tags_value,
                 )
                 return Context()
         except Exception:

releasenotes/notes/disable-internal-tag-propagation-dff3e799fb056584.yaml

@@ -0,0 +1,4 @@
+---
+other:
+  - |
+    tracing/internal: disable Datadog internal tag propagation