✨ [RUMF-1236] Add support for OTel headers #1832

yannickadam · 2022-11-21T13:54:34Z

Motivation

Users would like to use RUM alongside backends that are instrumented with OpenTelemetry, and benefit from the correlation of traces in APM.

Changes

Added a new RUM configuration property:
allowedTracingUrls: { match: MatchOption, propagatorTypes: ("datadog" | "tracecontext" | "b3" | "b3multi")[] }

datadog: Datadog (x-datadog-*)
tracecontext: Trace Context (traceparent)
b3: B3 Single Header (b3)
b3multi: B3 Multi Headers (X-B3-*)

This allows to select which propagator types to use when creating the request headers. It also gives more flexibility by providing the full URL to the match function (instead of origin).

Testing

Local
Staging
Unit
End to end

I have gone over the contributing documentation.

codecov-commenter · 2022-12-07T09:02:10Z

Codecov Report

Merging #1832 (dc7d21d) into main (0fe202a) will increase coverage by 0.01%.
The diff coverage is 95.28%.

@@            Coverage Diff             @@
##             main    #1832      +/-   ##
==========================================
+ Coverage   93.06%   93.07%   +0.01%     
==========================================
  Files         132      132              
  Lines        5103     5185      +82     
  Branches     1143     1173      +30     
==========================================
+ Hits         4749     4826      +77     
- Misses        354      359       +5

Impacted Files	Coverage Δ
packages/rum-core/src/domain/configuration.ts	`93.61% <91.22%> (-4.17%)`	⬇️
packages/core/src/browser/cookie.ts	`86.48% <100.00%> (ø)`
packages/core/src/tools/utils.ts	`82.94% <100.00%> (+0.26%)`	⬆️
packages/rum-core/src/domain/tracing/tracer.ts	`100.00% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

packages/rum-core/src/domain/configuration.spec.ts

packages/rum-core/src/domain/configuration.ts

packages/rum-core/src/domain/tracing/tracer.spec.ts

packages/rum-core/src/domain/tracing/tracer.ts

packages/rum-core/src/domain/configuration.ts

packages/rum-core/src/domain/tracing/tracer.types.ts

packages/rum-core/src/domain/tracing/tracer.ts

packages/rum-core/src/domain/configuration.ts

packages/rum-core/src/domain/tracing/tracer.spec.ts

zacharycmontoya · 2022-12-09T16:58:30Z

b3m: B3 Multi Headers (X-B3-*)

If we want to align this with OpenTelemetry conventions, we should name this b3multi, see https://opentelemetry.io/docs/reference/specification/sdk-environment-variables/

…ng review

zacharycmontoya · 2022-12-09T22:48:55Z

Also, the OTEL convention is the name tracecontext to represent the traceparent/tracestate headers, so it would be great to match that too

BenoitZugmeyer

This PR updates rum-events-format, but I don't think that was intended, maybe revert it

BenoitZugmeyer · 2022-12-12T10:21:53Z

packages/rum-core/src/domain/tracing/tracer.ts

+  propagatorTypes.forEach((propagatorType) => {
+    switch (propagatorType) {
+      case 'datadog': {


👏 praise: ‏It looks great, nice job!

zacharycmontoya

From an APM Tracer dev that's working on OTEL headers, this looks good to me 👍🏼

bcaudan · 2022-12-13T10:47:39Z

packages/core/src/tools/utils.ts

+    try {
+      if (typeof item === 'function') {


💬 suggestion: ‏if you had some error cases in mind when expanding the scope of the try/catch, it could be nice to add some tests for them

liywjl · 2022-12-08T12:40:03Z

packages/core/src/browser/cookie.ts

@@ -36,7 +36,7 @@ export function areCookiesAuthorized(options: CookieOptions): boolean {
    // the test cookie lifetime
    const testCookieName = `dd_cookie_test_${generateUUID()}`
    const testCookieValue = 'test'
-    setCookie(testCookieName, testCookieValue, ONE_SECOND, options)
+    setCookie(testCookieName, testCookieValue, ONE_MINUTE, options)


❓ question: I am curious why this needed changing?

naseemkullah · 2022-12-27T20:14:17Z

great job!

when will this be released? looking to use this asap cc @BenoitZugmeyer @liywjl

bcaudan · 2022-12-29T08:39:43Z

Hi @naseemkullah, it should be released early January.

yannickadam requested a review from a team as a code owner November 21, 2022 13:54

liywjl approved these changes Nov 21, 2022

View reviewed changes

yannickadam marked this pull request as draft November 21, 2022 16:02

🐛 Fix Cookies are not authorized random issue

22e641c

yannickadam force-pushed the yannick.adam/rumf-1236-otel-headers branch from c3a2f42 to 2f8a97d Compare December 6, 2022 23:23

yannickadam changed the title ~~✨ Add support for OTel headers~~ ✨ [RUMF-1236] Add support for OTel headers Dec 6, 2022

yannickadam marked this pull request as ready for review December 6, 2022 23:27

yannickadam force-pushed the yannick.adam/rumf-1236-otel-headers branch from 2f8a97d to 43dddef Compare December 7, 2022 08:58

yannickadam force-pushed the yannick.adam/rumf-1236-otel-headers branch 2 times, most recently from 427e90a to 896b641 Compare December 7, 2022 13:02

✨ Open Telemetry header support for APM

95c77f0

yannickadam force-pushed the yannick.adam/rumf-1236-otel-headers branch from 896b641 to 95c77f0 Compare December 7, 2022 13:20

liywjl self-requested a review December 8, 2022 09:43

BenoitZugmeyer reviewed Dec 8, 2022

View reviewed changes

bcaudan reviewed Dec 8, 2022

View reviewed changes

👌 Rename configureTracingUrls to allowedTracingUrls + Updates followi…

0074234

…ng review

yannickadam force-pushed the yannick.adam/rumf-1236-otel-headers branch 2 times, most recently from dc7d21d to a517875 Compare December 12, 2022 07:41

BenoitZugmeyer approved these changes Dec 12, 2022

View reviewed changes

yannickadam added 2 commits December 12, 2022 14:37

👌🎨 Reuse matchList in tracer

4b7ba12

👌 Renamed variables to follow OTel conventions

7c2c512

yannickadam force-pushed the yannick.adam/rumf-1236-otel-headers branch from a517875 to 7c2c512 Compare December 12, 2022 13:46

zacharycmontoya approved these changes Dec 12, 2022

View reviewed changes

bcaudan approved these changes Dec 13, 2022

View reviewed changes

liywjl approved these changes Dec 14, 2022

View reviewed changes

yannickadam merged commit 83b2be6 into main Dec 15, 2022

yannickadam deleted the yannick.adam/rumf-1236-otel-headers branch December 15, 2022 16:01

naseemkullah mentioned this pull request Dec 27, 2022

Keep APM<>RUM link when using OpenTelemetry JS tracer #1482

Open

This was linked to issues Jan 19, 2023

💡 Path customization for distributed tracing #1823

Closed

CORS issue with allowedTracingOrigins - RUM setup #1818

Closed

Support W3C tracing headers #1639

Closed

Keep APM<>RUM link when using OpenTelemetry JS tracer #1482

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ [RUMF-1236] Add support for OTel headers #1832

✨ [RUMF-1236] Add support for OTel headers #1832

yannickadam commented Nov 21, 2022 •

edited

Loading

codecov-commenter commented Dec 7, 2022 •

edited

Loading

zacharycmontoya commented Dec 9, 2022

zacharycmontoya commented Dec 9, 2022

BenoitZugmeyer left a comment

BenoitZugmeyer Dec 12, 2022

zacharycmontoya left a comment

bcaudan Dec 13, 2022

liywjl Dec 8, 2022

naseemkullah commented Dec 27, 2022

bcaudan commented Dec 29, 2022

✨ [RUMF-1236] Add support for OTel headers #1832

✨ [RUMF-1236] Add support for OTel headers #1832

Conversation

yannickadam commented Nov 21, 2022 • edited Loading

Motivation

Changes

Testing

codecov-commenter commented Dec 7, 2022 • edited Loading

Codecov Report

zacharycmontoya commented Dec 9, 2022

zacharycmontoya commented Dec 9, 2022

BenoitZugmeyer left a comment

Choose a reason for hiding this comment

BenoitZugmeyer Dec 12, 2022

Choose a reason for hiding this comment

zacharycmontoya left a comment

Choose a reason for hiding this comment

bcaudan Dec 13, 2022

Choose a reason for hiding this comment

liywjl Dec 8, 2022

Choose a reason for hiding this comment

naseemkullah commented Dec 27, 2022

bcaudan commented Dec 29, 2022

yannickadam commented Nov 21, 2022 •

edited

Loading

codecov-commenter commented Dec 7, 2022 •

edited

Loading