feat(traceparent): setting parent span from server #477

obecny · 2019-11-04T14:29:39Z

Which problem is this PR solving?

Fixes Allow linking the server-side HTML render with client side HTML fetch spans #457

Short description of the changes

It adds functionality of reading the server span using the trace context. It will allow to share context between server and client.

bg451

Awesome, should add documentation somewhere that this is something you cna do, similar to the link census docs.

packages/opentelemetry-plugin-document-load/src/utils.ts

codecov-io · 2019-11-04T17:38:50Z

Codecov Report

Merging #477 into master will increase coverage by 0.16%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #477      +/-   ##
==========================================
+ Coverage    92.5%   92.66%   +0.16%     
==========================================
  Files         136      137       +1     
  Lines        6511     6627     +116     
  Branches      593      587       -6     
==========================================
+ Hits         6023     6141     +118     
+ Misses        488      486       -2

Impacted Files	Coverage Δ
...y-core/src/context/propagation/HttpTraceContext.ts	`100% <100%> (ø)`	⬆️
...telemetry-plugin-document-load/src/documentLoad.ts	`98.09% <100%> (+0.05%)`	⬆️
...es/opentelemetry-node/src/instrumentation/utils.ts	`90.47% <0%> (-9.53%)`	⬇️
...opentelemetry-base/test/resources/resource.test.ts	`100% <0%> (ø)`	⬆️
packages/opentelemetry-tracing/src/config.ts	`100% <0%> (ø)`	⬆️
packages/opentelemetry-tracing/src/utility.ts	`100% <0%> (ø)`	⬆️
packages/opentelemetry-tracing/test/Span.test.ts	`100% <0%> (ø)`	⬆️
.../opentelemetry-plugin-dns/test/utils/assertSpan.ts	`100% <0%> (ø)`	⬆️
...ry-tracing/test/export/SimpleSpanProcessor.test.ts	`100% <0%> (ø)`	⬆️
...try-node/test/instrumentation/PluginLoader.test.ts	`100% <0%> (ø)`	⬆️
... and 10 more

obecny · 2019-11-04T18:25:13Z

Awesome, should add documentation somewhere that this is something you cna do, similar to the link census docs.

@bg451 updated readme

draffensperger

👍 Nice!!

draffensperger · 2019-11-06T02:25:31Z

packages/opentelemetry-plugin-document-load/src/documentLoad.ts

@@ -76,12 +84,17 @@ export class DocumentLoad extends BasePlugin<unknown> {
   * Collects information about performance and creates appropriate spans
   */
  private _collectPerformance() {
+    const windowWithTrace: WindowWithTrace = (window as unknown) as WindowWithTrace;
+    const serverContext =
+      parseTraceParent(windowWithTrace.traceparent || '') || undefined;


Given that parseTraceParent already will return null if it fails to parse, would this still work without the || undefined?

the undefined must be there as the SpanOptions.parent is optional and cannot be null so the typescript is complaining about it.

opentelemetry-js/packages/opentelemetry-types/src/trace/SpanOptions.ts

Line 49 in 0392064

parent?: Span | SpanContext;

dyladan · 2019-11-06T21:04:47Z

I'm sure it's much too late to bring something like this up but just for my own edification, why did you choose to embed the trace parent in a script tag with a variable as opposed to a meta tag like <meta name="traceparent" content="00-ab42124a3c573678d4d8b21ba52df3bf-d21f7bc17caa5aba-01"> like is common for things like csrf tokens? This would ensure it is available immediately for script execution regardless of script execution order, and would work in cases where things like CORS rules prevent certain JS scripts from running.

obecny · 2019-11-06T21:12:36Z

I'm sure it's much too late to bring something like this up but just for my own edification, why did you choose to embed the trace parent in a script tag with a variable as opposed to a meta tag like <meta name="traceparent" content="00-ab42124a3c573678d4d8b21ba52df3bf-d21f7bc17caa5aba-01"> like is common for things like csrf tokens? This would ensure it is available immediately for script execution regardless of script execution order, and would work in cases where things like CORS rules prevent certain JS scripts from running.

It is never too late to improve things :).
I think this is really a valid point. The implementation is similar as for opencensus. But I think it might make more sense to put it in meta as you suggested. @draffensperger what do you think about it ?

dyladan · 2019-11-06T21:34:16Z

If it isn't too late to change, I prefer the meta option. In addition to being outside of script execution, it is also more reliable and simplifies server-side implementation as HTML is much easier to parse/modify without unexpected side effects than JS is.

obecny · 2019-11-06T23:06:30Z

@dyladan you might have a look again, I changed the traceparent to be read from meta tag

draffensperger · 2019-11-07T14:36:52Z

Good idea about the meta tag! The reason it was in a <script> was just that we did it that way in OpenCensus and that was just because I didn't know about the value of meta tags :)

I think in the future it could potentially also allow it to be set via the Server Timing header, which is the only header that the JS client can read directly from the initial page load. That would allow something like a load balancer to inject it without changing the HTML. But that's a future improvement and should be optional!

dyladan

This looks great. Thanks for making the meta tag change.

dyladan · 2019-11-08T17:23:16Z

packages/opentelemetry-core/src/context/propagation/HttpTraceContext.ts

@@ -25,7 +25,17 @@ const VALID_SPANID_REGEX = /^[0-9a-f]{16}$/i;
 const INVALID_ID_REGEX = /^0+$/i;
 const VERSION = '00';

-function parse(traceParent: string): SpanContext | null {
+/**
+ * Parses information from [traceParent] window property and converts it into {@link SpanContext}


Suggested change

* Parses information from [traceParent] window property and converts it into {@link SpanContext}

* Parses information from the [traceparent] span tag and converts it into {@link SpanContext}

dyladan · 2019-11-08T17:25:41Z

Good idea about the meta tag! The reason it was in a <script> was just that we did it that way in OpenCensus and that was just because I didn't know about the value of meta tags :)

I think in the future it could potentially also allow it to be set via the Server Timing header, which is the only header that the JS client can read directly from the initial page load. That would allow something like a load balancer to inject it without changing the HTML. But that's a future improvement and should be optional!

Additionally, the trace context working group is going to be working on a trace context response header for this use specifically

feat(traceparent): setting parent span from server

d028135

obecny requested review from bg451, danielkhan, markwolff, mayurkale22, OlivierAlbertini, rochdev and vmarchaud as code owners November 4, 2019 14:29

bg451 approved these changes Nov 4, 2019

View reviewed changes

bg451 reviewed Nov 4, 2019

View reviewed changes

packages/opentelemetry-plugin-document-load/src/utils.ts Outdated Show resolved Hide resolved

obecny added 3 commits November 4, 2019 18:31

chore: exposing the parse functionality

20735e2

chore: refactored to use existing functionality

d7c3194

chore: adding jsdoc to exported function

865c50a

chore: updating readme with example for traceparent

5393ac7

Merge branch 'master' into document-load-traceparent

16bd3a6

mayurkale22 approved these changes Nov 5, 2019

View reviewed changes

markwolff approved these changes Nov 6, 2019

View reviewed changes

draffensperger approved these changes Nov 6, 2019

View reviewed changes

obecny added 2 commits November 6, 2019 11:59

Merge branch 'master' into document-load-traceparent

042d1d9

Merge branch 'master' into document-load-traceparent

f6bfdc5

obecny added 3 commits November 6, 2019 23:48

chore: moving the traceparent to meta instead of window

f8dc8e1

chore: merge branch 'master' into document-load-traceparent

5425430

chore: updating the jsdoc

feb4498

mayurkale22 approved these changes Nov 6, 2019

View reviewed changes

mayurkale22 added the feature-request label Nov 6, 2019

mayurkale22 mentioned this pull request Nov 7, 2019

Propose to add @obecny as the CODEOWNERS. #505

Merged

dyladan approved these changes Nov 8, 2019

View reviewed changes

dyladan reviewed Nov 8, 2019

View reviewed changes

obecny and others added 2 commits November 8, 2019 18:29

chore: updating the copy as suggested

0a19860

Merge branch 'master' into document-load-traceparent

53e7b1a

mayurkale22 merged commit 4f48357 into open-telemetry:master Nov 8, 2019

obecny deleted the document-load-traceparent branch July 8, 2020 12:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(traceparent): setting parent span from server #477

feat(traceparent): setting parent span from server #477

obecny commented Nov 4, 2019

bg451 left a comment

codecov-io commented Nov 4, 2019 •

edited

Loading

obecny commented Nov 4, 2019

draffensperger left a comment

draffensperger Nov 6, 2019

obecny Nov 6, 2019

dyladan commented Nov 6, 2019

obecny commented Nov 6, 2019

dyladan commented Nov 6, 2019

obecny commented Nov 6, 2019

draffensperger commented Nov 7, 2019

dyladan left a comment

dyladan Nov 8, 2019

dyladan commented Nov 8, 2019

	* Parses information from [traceParent] window property and converts it into {@link SpanContext}
	* Parses information from the [traceparent] span tag and converts it into {@link SpanContext}

feat(traceparent): setting parent span from server #477

feat(traceparent): setting parent span from server #477

Conversation

obecny commented Nov 4, 2019

Which problem is this PR solving?

Short description of the changes

bg451 left a comment

Choose a reason for hiding this comment

codecov-io commented Nov 4, 2019 • edited Loading

Codecov Report

obecny commented Nov 4, 2019

draffensperger left a comment

Choose a reason for hiding this comment

draffensperger Nov 6, 2019

Choose a reason for hiding this comment

obecny Nov 6, 2019

Choose a reason for hiding this comment

dyladan commented Nov 6, 2019

obecny commented Nov 6, 2019

dyladan commented Nov 6, 2019

obecny commented Nov 6, 2019

draffensperger commented Nov 7, 2019

dyladan left a comment

Choose a reason for hiding this comment

dyladan Nov 8, 2019

Choose a reason for hiding this comment

dyladan commented Nov 8, 2019

codecov-io commented Nov 4, 2019 •

edited

Loading