WIP: otel baggage support proof of concept #4563

ida613 · 2024-07-31T13:51:26Z

What does this PR do?

Motivation

Plugin Checklist

Additional Notes

github-actions · 2024-07-31T13:52:14Z

Overall package size

Self size: 7.17 MB
Deduped: 62.53 MB
No deduping: 62.81 MB

Dependency sizes

| name | version | self size | total size | |------|---------|-----------|------------| | @datadog/native-appsec | 8.1.1 | 18.67 MB | 18.68 MB | | @datadog/native-iast-taint-tracking | 3.1.0 | 12.27 MB | 12.28 MB | | @datadog/pprof | 5.3.0 | 9.85 MB | 10.22 MB | | protobufjs | 7.2.5 | 2.77 MB | 5.16 MB | | @datadog/native-iast-rewriter | 2.4.1 | 2.14 MB | 2.23 MB | | @opentelemetry/core | 1.14.0 | 872.87 kB | 1.47 MB | | @datadog/native-metrics | 2.0.0 | 898.77 kB | 1.3 MB | | @opentelemetry/api | 1.8.0 | 1.21 MB | 1.21 MB | | jsonpath-plus | 9.0.0 | 580.4 kB | 1.03 MB | | import-in-the-middle | 1.8.1 | 71.67 kB | 785.15 kB | | msgpack-lite | 0.1.26 | 201.16 kB | 281.59 kB | | opentracing | 0.14.7 | 194.81 kB | 194.81 kB | | pprof-format | 2.1.0 | 111.69 kB | 111.69 kB | | @datadog/sketches-js | 2.1.0 | 109.9 kB | 109.9 kB | | semver | 7.6.3 | 95.82 kB | 95.82 kB | | lodash.sortby | 4.7.0 | 75.76 kB | 75.76 kB | | lru-cache | 7.14.0 | 74.95 kB | 74.95 kB | | ignore | 5.3.1 | 51.46 kB | 51.46 kB | | int64-buffer | 0.1.10 | 49.18 kB | 49.18 kB | | shell-quote | 1.8.1 | 44.96 kB | 44.96 kB | | istanbul-lib-coverage | 3.2.0 | 29.34 kB | 29.34 kB | | rfdc | 1.3.1 | 25.21 kB | 25.21 kB | | tlhunter-sorted-set | 0.1.0 | 24.94 kB | 24.94 kB | | limiter | 1.1.5 | 23.17 kB | 23.17 kB | | dc-polyfill | 0.1.4 | 23.1 kB | 23.1 kB | | retry | 0.13.1 | 18.85 kB | 18.85 kB | | jest-docblock | 29.7.0 | 8.99 kB | 12.76 kB | | crypto-randomuuid | 1.0.0 | 11.18 kB | 11.18 kB | | koalas | 1.0.2 | 6.47 kB | 6.47 kB | | path-to-regexp | 0.1.10 | 6.38 kB | 6.38 kB | | module-details-from-path | 1.0.3 | 4.47 kB | 4.47 kB |

_{🤖 This report was automatically generated by heaviest-objects-in-the-universe}

pr-commenter · 2024-07-31T13:59:33Z

Benchmarks

Benchmark execution time: 2024-09-20 19:43:26

Comparing candidate commit dae0866 in PR branch ida613/baggage with baseline commit 470194a in branch master.

Found 0 performance improvements and 3 performance regressions! Performance is the same for 256 metrics, 7 unstable metrics.

scenario:plugin-graphql-with-depth-and-collapse-on-18

🟥 max_rss_usage [+71.577MB; +127.423MB] or [+8.348%; +14.860%]

scenario:plugin-graphql-with-depth-off-18

🟥 max_rss_usage [+82.016MB; +84.192MB] or [+9.620%; +9.875%]

scenario:plugin-graphql-with-depth-on-max-18

🟥 max_rss_usage [+76.251MB; +88.673MB] or [+8.872%; +10.318%]

lucaspimentel · 2024-07-31T18:49:46Z

packages/dd-trace/src/config.js

+    this._setValue(defaults, 'baggagePropagation', true)
+    this._setValue(defaults, 'baggageInject', true)
+    this._setValue(defaults, 'baggageExtract', true)


The idea was that the separate inject/extract settings take precedence over the third setting if they are explicitly set by the user. I don't know how you would handle this in Node.js, but you may want to set the default for those two as undefined so yo can distinguish between a true set by the user and a true that was the default value.

The idea is that in most cases users only need to set DD_TRACE_BAGGAGE_ENABLED and DD_TRACE_BAGGAGE_[INJECT|EXTRACT]_ENABLED are only used in edge cases.

This is similar to what we do with

// used for both extract and inject below if those are not set explicitly DD_TRACE_PROPAGATION_STYLE overrides DD_TRACE_PROPAGATION_STYLE for extraction only DD_TRACE_PROPAGATION_STYLE_EXTRACT overrides DD_TRACE_PROPAGATION_STYLE for injection only DD_TRACE_PROPAGATION_STYLE_INJECT

lucaspimentel · 2024-07-31T18:58:05Z

packages/dd-trace/src/opentracing/span.js

@@ -145,6 +145,18 @@ class DatadogSpan {
    return this._spanContext._baggageItems[key]
  }

+  getAllBaggageItems () {
+    return this._spanContext._baggageItems


These 3 functions LGTM. My only question is, should we return _baggageItems directly here, or instead return an immutable copy, or something like an iterator? The OpenTelemetry spec says we should, but I don't think we necessarily need to follow that in the this API. Are there any concerns with exposing the internal _baggageItems to users? This may vary between languages.

good idea, I'll return an immutable copy to be safe

codecov · 2024-08-05T23:38:50Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.19%. Comparing base (d871335) to head (d1a2be3).

Additional details and impacted files

@@             Coverage Diff             @@
##           master    #4563       +/-   ##
===========================================
- Coverage   92.13%   69.19%   -22.95%     
===========================================
  Files         105        1      -104     
  Lines        3384      198     -3186     
  Branches       33       33               
===========================================
- Hits         3118      137     -2981     
+ Misses        266       61      -205

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…ida613/baggage

otel baggage support

1d46ff2

ida613 added the semver-minor label Jul 31, 2024

ida613 added 3 commits July 31, 2024 14:26

modified otel baggage support

951e4cb

bug fix

d14fe44

removed undefined function

55c9880

lucaspimentel reviewed Jul 31, 2024

View reviewed changes

ida613 added 4 commits July 31, 2024 16:33

unit test

0d626b2

update implementation

87d8174

added encoding

f49cb62

add span formatting

700f022

ida613 added 14 commits August 6, 2024 14:56

revert format changes

c0f74d8

update config options

d6672cc

updated http encoding

d98648b

remove comments

7ffc64a

add noop and otel baggage support

4880dea

Merge branch 'master' into ida613/baggage

a4b90c7

updated according to rfc

b2ff71c

Merge branch 'master' into ida613/baggage

d1a2be3

fix unit test

49aaa7a

Merge branch 'ida613/baggage' of github.com:DataDog/dd-trace-js into …

d514bed

…ida613/baggage

Merge branch 'master' into ida613/baggage

32e91a7

update span api

8b9b917

logging debugging message

de79a4e

Merge branch 'master' into ida613/baggage

dae0866

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: otel baggage support proof of concept #4563

WIP: otel baggage support proof of concept #4563

ida613 commented Jul 31, 2024 •

edited

Loading

github-actions bot commented Jul 31, 2024 •

edited

Loading

pr-commenter bot commented Jul 31, 2024 •

edited

Loading

lucaspimentel Jul 31, 2024 •

edited

Loading

lucaspimentel Jul 31, 2024

ida613 Jul 31, 2024

codecov bot commented Aug 5, 2024 •

edited

Loading

WIP: otel baggage support proof of concept #4563

Are you sure you want to change the base?

WIP: otel baggage support proof of concept #4563

Conversation

ida613 commented Jul 31, 2024 • edited Loading

What does this PR do?

Motivation

Plugin Checklist

Additional Notes

github-actions bot commented Jul 31, 2024 • edited Loading

Overall package size

pr-commenter bot commented Jul 31, 2024 • edited Loading

Benchmarks

scenario:plugin-graphql-with-depth-and-collapse-on-18

scenario:plugin-graphql-with-depth-off-18

scenario:plugin-graphql-with-depth-on-max-18

lucaspimentel Jul 31, 2024 • edited Loading

Choose a reason for hiding this comment

lucaspimentel Jul 31, 2024

Choose a reason for hiding this comment

ida613 Jul 31, 2024

Choose a reason for hiding this comment

codecov bot commented Aug 5, 2024 • edited Loading

Codecov Report

ida613 commented Jul 31, 2024 •

edited

Loading

github-actions bot commented Jul 31, 2024 •

edited

Loading

pr-commenter bot commented Jul 31, 2024 •

edited

Loading

lucaspimentel Jul 31, 2024 •

edited

Loading

codecov bot commented Aug 5, 2024 •

edited

Loading