feat(tracer): re-enable v05 trace encoding (#7878)

Follow up to: #7874

## Checklist

- [x] Change(s) are motivated and described in the PR description.
- [x] Testing strategy is described if automated tests are not included
in the PR.
- [x] Risk is outlined (performance impact, potential for breakage,
maintainability, etc).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed. If no release note is required, add label
`changelog/no-changelog`.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist

- [ ] Title is accurate.
- [ ] No unnecessary changes are introduced.
- [ ] Description motivates each change.
- [ ] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [ ] Testing strategy adequately addresses listed risk(s).
- [ ] Change is maintainable (easy to change, telemetry, documentation).
- [ ] Release note makes sense to a user of the library.
- [ ] Reviewer has explicitly 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)
- [ ] If this PR touches code that signs or publishes builds or
packages, or handles credentials of any kind, I've requested a review
from `@DataDog/security-design-and-guidance`.
- [ ] This PR doesn't touch any of that.

Author: mabdinur

ddtrace/internal/writer/writer.py

@@ -35,6 +35,8 @@
 from ..encoding import JSONEncoderV2
 from ..logger import get_logger
 from ..runtime import container
+from ..serverless import in_azure_function_consumption_plan
+from ..serverless import in_gcp_function
 from ..sma import SimpleMovingAverage
 from .writer_client import WRITER_CLIENTS
 from .writer_client import AgentWriterClientV3
@@ -478,7 +480,11 @@ def __init__(
         #      https://docs.python.org/3/library/sys.html#sys.platform
         is_windows = sys.platform.startswith("win") or sys.platform.startswith("cygwin")
 
-        self._api_version = api_version or config._trace_api or ("v0.4" if priority_sampling else "v0.3")
+        default_api_version = "v0.5"
+        if is_windows or in_gcp_function() or in_azure_function_consumption_plan():
+            default_api_version = "v0.4"
+
+        self._api_version = api_version or config._trace_api or default_api_version
         if is_windows and self._api_version == "v0.5":
             raise RuntimeError(
                 "There is a known compatibility issue with v0.5 API and Windows, "

docs/configuration.rst

@@ -287,7 +287,7 @@ The following environment variables for the tracer are supported:
 
    DD_TRACE_API_VERSION:
      default: |
-         ``v0.4``
+         ``v0.5``
      description: |
          The trace API version to use when sending traces to the Datadog agent.
 
@@ -296,6 +296,7 @@ The following environment variables for the tracer are supported:
        v0.56.0:
        v1.7.0: default changed to ``v0.5``.
        v1.19.1: default reverted to ``v0.4``.
+       v2.4.0: default changed to ``v0.5``.
 
    DD_TRACE_OBFUSCATION_QUERY_STRING_REGEXP:
      default: |

releasenotes/notes/upgrade-encoding-to-v05-601bce23c0928d8f.yaml

@@ -0,0 +1,4 @@
+---
+other:
+  - |
+    tracing: Upgrades the trace encoding format to v0.5. This change improves the performance of encoding and sending spans.

tests/integration/test_integration.py

@@ -127,7 +127,7 @@ def test_uds_wrong_socket_path():
         mock.call(
             "failed to send, dropping %d traces to intake at %s after %d retries",
             1,
-            "unix:///tmp/ddagent/nosockethere/{}/traces".format(encoding if encoding else "v0.4"),
+            "unix:///tmp/ddagent/nosockethere/{}/traces".format(encoding if encoding else "v0.5"),
             3,
         )
     ]
@@ -403,7 +403,7 @@ def test_trace_generates_error_logs_when_hostname_invalid():
         mock.call(
             "failed to send, dropping %d traces to intake at %s after %d retries",
             1,
-            "http://bad:1111/{}/traces".format(encoding if encoding else "v0.4"),
+            "http://bad:1111/{}/traces".format(encoding if encoding else "v0.5"),
             3,
         )
     ]
@@ -492,7 +492,7 @@ def test_trace_with_invalid_payload_generates_error_log():
         [
             mock.call(
                 "failed to send traces to intake at %s: HTTP error status %s, reason %s",
-                "http://localhost:8126/v0.4/traces",
+                "http://localhost:8126/v0.5/traces",
                 400,
                 "Bad Request",
             )
@@ -571,7 +571,7 @@ def test_api_version_downgrade_generates_no_warning_logs():
 
     from ddtrace import tracer as t
 
-    encoding = os.environ["DD_TRACE_API_VERSION"] or "v0.4"
+    encoding = os.environ["DD_TRACE_API_VERSION"] or "v0.5"
     t._writer._downgrade(None, None, t._writer._clients[0])
     assert t._writer._endpoint == {"v0.5": "v0.4/traces", "v0.4": "v0.3/traces"}[encoding]
     with mock.patch("ddtrace.internal.writer.writer.log") as log:

tests/snapshots/test_extended_sampling_resource.json

@@ -1,11 +1,13 @@
 [[
   {
     "name": "should_not_send",
-    "service": null,
+    "service": "",
     "resource": "mycoolre$ource",
     "trace_id": 0,
     "span_id": 1,
     "parent_id": 0,
+    "type": "",
+    "error": 0,
     "meta": {
       "_dd.p.dm": "-3",
       "language": "python",
@@ -24,11 +26,13 @@
 [
   {
     "name": "should_send",
-    "service": null,
+    "service": "",
     "resource": "something else",
     "trace_id": 1,
     "span_id": 1,
     "parent_id": 0,
+    "type": "",
+    "error": 0,
     "meta": {
       "_dd.p.dm": "-0",
       "language": "python",

tests/snapshots/test_extended_sampling_tags.json

@@ -1,11 +1,13 @@
 [[
   {
     "name": "should_not_send",
-    "service": null,
+    "service": "",
     "resource": "should_not_send",
     "trace_id": 0,
     "span_id": 1,
     "parent_id": 0,
+    "type": "",
+    "error": 0,
     "meta": {
       "_dd.p.dm": "-3",
       "language": "python",
@@ -25,11 +27,13 @@
 [
   {
     "name": "should_send",
-    "service": null,
+    "service": "",
     "resource": "should_send",
     "trace_id": 1,
     "span_id": 1,
     "parent_id": 0,
+    "type": "",
+    "error": 0,
     "meta": {
       "_dd.p.dm": "-0",
       "banana": "True",

tests/snapshots/test_extended_sampling_tags_and_resource.json

@@ -1,11 +1,13 @@
 [[
   {
     "name": "should_not_send",
-    "service": null,
+    "service": "",
     "resource": "mycoolre$ource",
     "trace_id": 0,
     "span_id": 1,
     "parent_id": 0,
+    "type": "",
+    "error": 0,
     "meta": {
       "_dd.p.dm": "-3",
       "language": "python",
@@ -25,11 +27,13 @@
 [
   {
     "name": "should_send1",
-    "service": null,
+    "service": "",
     "resource": "should_send1",
     "trace_id": 1,
     "span_id": 1,
     "parent_id": 0,
+    "type": "",
+    "error": 0,
     "meta": {
       "_dd.p.dm": "-0",
       "banana": "True",
@@ -48,11 +52,13 @@
 [
   {
     "name": "should_send2",
-    "service": null,
+    "service": "",
     "resource": "banana",
     "trace_id": 2,
     "span_id": 1,
     "parent_id": 0,
+    "type": "",
+    "error": 0,
     "meta": {
       "_dd.p.dm": "-0",
       "language": "python",
@@ -71,11 +77,13 @@
 [
   {
     "name": "should_send3",
-    "service": null,
+    "service": "",
     "resource": "mycoolre$ource",
     "trace_id": 3,
     "span_id": 1,
     "parent_id": 0,
+    "type": "",
+    "error": 0,
     "meta": {
       "_dd.p.dm": "-0",
       "banana": "True",

tests/snapshots/test_extended_sampling_tags_glob.json

@@ -1,11 +1,13 @@
 [[
   {
     "name": "should_not_send",
-    "service": null,
+    "service": "",
     "resource": "should_not_send",
     "trace_id": 0,
     "span_id": 1,
     "parent_id": 0,
+    "type": "",
+    "error": 0,
     "meta": {
       "_dd.p.dm": "-3",
       "language": "python",
@@ -25,11 +27,13 @@
 [
   {
     "name": "should_send",
-    "service": null,
+    "service": "",
     "resource": "should_send",
     "trace_id": 1,
     "span_id": 1,
     "parent_id": 0,
+    "type": "",
+    "error": 0,
     "meta": {
       "_dd.p.dm": "-0",
       "language": "python",

tests/snapshots/test_multi_trace.json

@@ -1,11 +1,13 @@
 [[
   {
     "name": "root0",
-    "service": null,
+    "service": "",
     "resource": "root0",
     "trace_id": 0,
     "span_id": 1,
     "parent_id": 0,
+    "type": "",
+    "error": 0,
     "meta": {
       "_dd.p.dm": "-0",
       "language": "python",
@@ -22,22 +24,26 @@
   },
      {
        "name": "child0",
-       "service": null,
+       "service": "",
        "resource": "child0",
        "trace_id": 0,
        "span_id": 2,
        "parent_id": 1,
+       "type": "",
+       "error": 0,
        "duration": 29000,
        "start": 1633030641740720000
      }],
 [
   {
     "name": "root1",
-    "service": null,
+    "service": "",
     "resource": "root1",
     "trace_id": 1,
     "span_id": 1,
     "parent_id": 0,
+    "type": "",
+    "error": 0,
     "meta": {
       "_dd.p.dm": "-0",
       "language": "python",
@@ -54,11 +60,13 @@
   },
      {
        "name": "child1",
-       "service": null,
+       "service": "",
        "resource": "child1",
        "trace_id": 1,
        "span_id": 2,
        "parent_id": 1,
+       "type": "",
+       "error": 0,
        "duration": 15000,
        "start": 1633030641741273000
      }]]

tests/snapshots/test_sampling_with_default_sample_rate_1.json

@@ -1,11 +1,13 @@
 [[
   {
     "name": "trace2",
-    "service": null,
+    "service": "",
     "resource": "trace2",
     "trace_id": 0,
     "span_id": 1,
     "parent_id": 0,
+    "type": "",
+    "error": 0,
     "meta": {
       "_dd.p.dm": "-3",
       "language": "python",
@@ -23,11 +25,13 @@
   },
      {
        "name": "child",
-       "service": null,
+       "service": "",
        "resource": "child",
        "trace_id": 0,
        "span_id": 2,
        "parent_id": 1,
+       "type": "",
+       "error": 0,
        "duration": 11602,
        "start": 1692637140104307759
      }]]