Added Http Trace Context #143

Tianlin-Zhao · 2020-06-30T21:43:33Z

This PR is has the full implemented version of Http Text Format i.e. Http Trace Context without the Trace State. All Trace State related code are commented out for the sake of compilation.

Modification is made to span.h to remove tracer field from class Span because otherwise Span and Tracer would define upon each other.

linux-foundation-easycla · 2020-06-30T21:43:38Z

The committers are authorized under a signed CLA.

✅ Tianlin-Zhao (591e76e, 1139a77, 74254f5, 7ebbdfe, 13f4233, b002241, d6d1935, 188fc2f, cc9b625, 8a38571, 483ca4c, b38d6d2, 2056be7, af166aa, 0c0ef2a, ffb22e7, d6be256, 5700e4b, df52301, c0c33dd, cd057c4, 60d95a7, 71f339f, f7aa306, 86125fc, 5caa0c1, 366f5ad, 63d8c91, c055a2e, af02f8b, 7a68570, 6292692, d0e637d, 555e05c, 8245e6a, 0442a52, 29e89de, fb29a2b, 6cff40e, f614fb9, 838c94e, b09a788, 2e2f9df, 4476a31, c88cc14, 2f081d8, dd2d515, a4e1cbd, 974d1bd, c1314cb, c5f1f2d, 77abce8, d3a1931, ed44b0a, 1462b48, 5d13af0, 49200ac, d2c3ebf, aacecd5, bf134b8, 3647d6a, 956055b, 374d7c4, 2873ef0, 692967b, b8df0b1, 26da008, 98ca4e0, 6826a41, 1f47c39, 2ded3e1, fc1ef96, 94831ab, 23d78d1, 24ab44b, b64427e, 78c4158, 77ca5ca, 3f0173c, f0db27e, a58b4ee, 76d6f29, 93e0e66, 7a2d5f2, 69fc0d6, 818865f, 6dccadf, 8b84e55, 3290a17, 0eb2e77, 1f0b6e1, e0c8d5f, e602890, 1a5d792, c2952e8, 1f0d5e7, acdf179, a6c150b, 19a4cd5, 28e4d0a, d22b43e, 5429141, 8c3d6fd, 81a0640, 513b0e0, f388ac1, 94834dd, 5026789, fe62212, 92f0e0f, 6d90293, 25e549d, 5a71b43, 01d8cec, 427030a, d8bbd52, 7580adb, 544855b, 349fbb9, 4104e91, bbdfed1, d67c502, cf25139, 10463c0, c0ac15e, 36b3241, 6b6b533, c706b4c, 053d92e, 458d4aa, 20f747b, 5e2ee69, bc3fb98, 38a94a5, fa070d4, 0e0d344, e0c63d3, 886d893, bcfb751, d2fc434, 3ebe9e6, 6d0cd8b, 20259a9, 11efe1f, c1adf5a, a19cd59, d392f64, d774328, 99be4b7, 87ae915, a78b5d1, 17d8c3e, 9168e67, e4d6474, 47b6a6f, c78c8cb, edd9188, 9e4e820, 6d4a23f, d95f29e, 7a9e9ba, fa90b35, c1fb682, 5fe65b6, 5701303, c42cd38, 07c5930, b182a5f, 3887dc7, 1d47802, 0d53d33, 2de9266, cd47c3a, e7ebefa, 820dd14, 7dc1203, 3f73d5d, 3fa337a, f31f9fa, 93a9389, 5bf0693, 544c0ee, 2064606, 69b688c, aee8cfd, 5e054ee, d066f4e, c0e74ff, 466d4f3, c5164c9, 2cd73ce, bd41f80, 051089d, 249c32c, b6002fc, 3e89067, 19ca833, 5d6a288, 1a90fec, 8aa9b7f, 1c89300, f928930, 2e813fb, 017e470, 9bb3984, 3eb1d6a, a0e2f23, 51a380a, d5edbec, 8ac9486, af1b484, eddb689, fabc345, 0a8021a, 31220c6, 190a7fa, fd8dd98, 185e8a3, 432ab0d, d0724ae, 0b1a90f, f0c1c9d, 8e6c3a1, eb8c38f, dd7f65d, bae2047, e8eeb9d, d86fbd3, 4ff679b, 3f03636, 42c1ace, 5f23ebe, 09bd626, c7aa9ae, 186f47f, 987b90c, e063cb7, f423173, 2925d5a, 5eaa32d, ba2bfaa, 1dfc9d7, 6acc97f, b04a00f, c367480, e98bb2a, 127c6f1, 7df20dd, c6690b0)
✅ ZhaoTianlin990121 (5b66308)

codecov · 2020-06-30T21:45:28Z

Codecov Report

Merging #143 into master will increase coverage by 0.11%.
The diff coverage is 94.73%.

@@            Coverage Diff             @@
##           master     #143      +/-   ##
==========================================
+ Coverage   94.43%   94.55%   +0.11%     
==========================================
  Files         146      146              
  Lines        6597     6610      +13     
==========================================
+ Hits         6230     6250      +20     
+ Misses        367      360       -7

Impacted Files	Coverage Δ
api/include/opentelemetry/trace/span.h	`100.00% <ø> (ø)`
sdk/src/trace/span.h	`0.00% <0.00%> (ø)`
api/include/opentelemetry/trace/noop.h	`85.18% <100.00%> (+25.92%)`	⬆️
api/include/opentelemetry/trace/span_context.h	`100.00% <100.00%> (ø)`
api/test/trace/noop_test.cc	`100.00% <100.00%> (ø)`
sdk/test/trace/span_data_test.cc	`100.00% <0.00%> (ø)`

reyang · 2020-07-01T15:27:49Z

.gitignore

@@ -34,3 +34,8 @@

 # Bazel files
 /bazel-*
+/.idea/


This seems to be IDE specific files, would you put them in a separate section (and put a comment)?

Yes, I'll do that right away. Actually, do you mind to see the other PR I've made sometime before?

#129

It contains the header I'd like to merge into while this PR is more about consulting about some of the coding details.

Why are the lines below needed? Isn't the whole .idea subdir ignored?

Also I'm not sure this belongs in the .gitignore file at all. I'd like to avoid e.g. every single IDE/editor being covered here.

They should have been removed by now.

Do you still plan to keep this line?

I've commited those changes to remove it.

g-easy · 2020-07-06T07:59:10Z

.gitignore

@@ -34,3 +34,8 @@

 # Bazel files
 /bazel-*
+/.idea/


Why are the lines below needed? Isn't the whole .idea subdir ignored?

Also I'm not sure this belongs in the .gitignore file at all. I'd like to avoid e.g. every single IDE/editor being covered here.

api/include/opentelemetry/trace/default_span.cc

api/include/opentelemetry/trace/propagation/HttpTraceContext.cc

api/include/opentelemetry/trace/trace_state.h

Tianlin-Zhao · 2020-07-07T02:10:32Z

Okay, so from today's meeting, I learned that I have to separate the code I made now into api and sdk folders. Could anyone specify more which should be in api and which should be in sdks?

api/include/opentelemetry/trace/default_span.h

api/include/opentelemetry/trace/propagation/HttpTraceContext.cc

api/include/opentelemetry/trace/trace_id.h

api/include/opentelemetry/trace/trace_state.h

api/test/trace/propagation/httptextformat_test.cc

api/include/opentelemetry/trace/propagation/HttpTraceContext.cc

api/include/opentelemetry/trace/propagation/http_trace_context.h

api/include/opentelemetry/trace/propagation/http_text_format.h

api/include/opentelemetry/trace/propagation/http_trace_context.h

api/test/trace/propagation/http_text_format_test.cc

api/include/opentelemetry/propagators/composite_http_propagator.h

Origin/propagators

…propagators # Conflicts: # api/include/opentelemetry/trace/propagation/http_trace_context.h

Origin/propagators

reyang · 2020-08-25T03:06:15Z

api/include/opentelemetry/trace/propagation/http_trace_context.h

+    }
+  }
+
+  static void GenerateBuffer(nostd::string_view string, int bytes, uint8_t *buf)


Where is the buffer limit? Consider adding comment to this function and explain what's the intended behavior.

Added function comments

reyang · 2020-08-25T03:06:33Z

api/include/opentelemetry/trace/propagation/http_trace_context.h

+    }
+  }
+
+  static void GenerateBuffer(nostd::string_view string, int bytes, uint8_t *buf)


The name GenerateBuffer is misleading.

Changed name to GenerateHexFromString

lalitb · 2020-08-25T04:54:43Z

sdk/src/trace/span.h

@@ -53,6 +53,7 @@ class Span final : public trace_api::Span
  mutable std::mutex mu_;
  std::unique_ptr<Recordable> recordable_;
  opentelemetry::core::SteadyTimestamp start_steady_time;
+  std::shared_ptr<trace_api::SpanContext> span_context_;


Not sure if I am missing something, but how is SpanContext going to be initialized. Don't see this passed in constructor.

Also, see whether it need to be unique_ptr - ideally Span should fully own it's context. <shared_ptr> have performance impact so should be avoided unless we can't.

Changed to unique ptr

lalitb · 2020-08-25T05:04:08Z

api/include/opentelemetry/trace/default_span.h

+namespace trace
+{
+class DefaultSpan : public Span
+{


nitpik: Can we use override keyword for the function which are virtually defined in Span base class. Will make this class more readable.

I just did it.

lalitb · 2020-08-25T05:12:09Z

api/include/opentelemetry/trace/default_tracer.h

+   */
+  nostd::unique_ptr<Span> StartSpan(nostd::string_view name,
+                                    const KeyValueIterable &attributes,
+                                    const StartSpanOptions &options = {}) noexcept


nitpik: override this, and below two functions.

Same as above

lalitb · 2020-08-25T05:15:46Z

api/include/opentelemetry/trace/noop.h


  void SetToken(nostd::unique_ptr<context::Token> && /* token */) noexcept override {}

 private:
  std::shared_ptr<Tracer> tracer_;
+  SpanContext span_context_;


how is this being initialized? should it be in constructor ?

This is just a placeholder to conform to its parent class Span, I don't think it's being used.

lalitb · 2020-08-25T05:29:40Z

api/include/opentelemetry/trace/propagation/http_trace_context.h

+    return context.SetValue(span_key, sp);
+  }
+
+  static void GetCurrentSpan(const context::Context &context, SpanContext &span_context)


should this have public access ?

Yes because it can be used elsewhere and so it is public in Python version I believe

lalitb · 2020-08-25T05:30:03Z

api/include/opentelemetry/trace/propagation/http_trace_context.h

+    setter(carrier, kTraceParent, hex_string);
+  }
+
+  static void InjectImpl(Setter setter, T &carrier, const SpanContext &span_context)


should this have public access ? please check this for all the member functions.

I think all is cool except for the GenerateHexFromString, the rest are useful because they are useful functions outside of this class as well and they also need tests to make sure they are correct, although I have changed the GenerateHexFromString to private.

lalitb · 2020-08-25T06:31:40Z

api/include/opentelemetry/trace/propagation/http_trace_context.h

+static const nostd::string_view kTraceParent = "traceparent";
+static const nostd::string_view kTraceState  = "tracestate";
+static const int kTraceDelimiterBytes        = 3;
+static const int kHeaderElementLengths[4]    = {2, 32, 16, 2};


This is confusing now. It's important to know what these numbers indicate - which is getting missed now. Better to have constants as defined earlier, and use them within kHeaderElementLengths array. Also, size of trace_id is 16 bytes, and span_id is 8 bytes. Why are we using 32 bytes and 16 bytes here ?

I just followed a recommendation to remove the definitions and convert them into this form though. I could provide comments on the size to bolster understanding.

Assuming you're referring to #143 (comment), there wasn't a recommendation to remove the definitions. reyang pointed out that the numbers are repeated, but didn't say "get rid of the constants".

I agree with lalitb: the constants give useful mnemonics to the values.

Regarding why the values are {2,32,16,2} - these are characters in a hex string, which encode nibbles not bytes. The count is 2:1 with the byte size.

So I just added those constants back but this time with those constants using the values stored in kHeadeElementLengths as definition.

reyang · 2020-08-25T20:13:45Z

api/include/opentelemetry/trace/propagation/http_text_format.h

+};
+}  // namespace propagation
+}  // namespace trace
+OPENTELEMETRY_END_NAMESPACE


nit: put a blank line before EOF (and change the other files).

Fixed and just pushed

reyang · 2020-08-25T20:15:33Z

api/include/opentelemetry/trace/propagation/http_trace_context.h

+{
+static const nostd::string_view kTraceParent = "traceparent";
+static const nostd::string_view kTraceState  = "tracestate";
+static const int kTraceDelimiterBytes        = 3;


Why do we need this? Should this be the number of components - 1?

Yes right now it is the number of componets - 1, but this variable is used to calculate the length of a trace parent hence I think it might make more sense to refer to it as a length unit.

reyang

LGTM, left some minor suggestions.

Tianlin-Zhao requested a review from a team June 30, 2020 21:43

reyang reviewed Jul 1, 2020

View reviewed changes

g-easy reviewed Jul 6, 2020

View reviewed changes

maxgolov reviewed Jul 6, 2020

View reviewed changes

api/include/opentelemetry/trace/propagation/HttpTraceContext.cc Outdated Show resolved Hide resolved

maxgolov reviewed Jul 6, 2020

View reviewed changes

api/include/opentelemetry/trace/propagation/HttpTraceContext.cc Outdated Show resolved Hide resolved

maxgolov reviewed Jul 6, 2020

View reviewed changes

api/include/opentelemetry/trace/trace_state.h Outdated Show resolved Hide resolved

maxgolov reviewed Jul 6, 2020

View reviewed changes

api/include/opentelemetry/trace/trace_state.h Outdated Show resolved Hide resolved

maxgolov reviewed Jul 6, 2020

View reviewed changes

api/include/opentelemetry/trace/trace_state.h Outdated Show resolved Hide resolved

0x4b suggested changes Jul 9, 2020

View reviewed changes

0x4b mentioned this pull request Jul 10, 2020

Context api dummy methods #155

Closed

0x4b reviewed Jul 29, 2020

View reviewed changes

api/include/opentelemetry/propagators/composite_http_propagator.h Outdated Show resolved Hide resolved

Tianlin-Zhao added 10 commits July 29, 2020 20:07

tracer workaround

d0e637d

tracer workaround

555e05c

tracer workaround

8245e6a

tracer workaround

0442a52

tracer workaround

29e89de

tracer workaround

fb29a2b

tracer workaround

6cff40e

tracer workaround

f614fb9

Merge branch 'origin/propagation' into origin/propagators

838c94e

Merge pull request #9 from Tianlin-Zhao/origin/propagators

b09a788

Origin/propagators

Tianlin-Zhao mentioned this pull request Jul 30, 2020

Context Propagation Update: Headers #129

Closed

Tianlin-Zhao added 4 commits July 30, 2020 12:59

tracer workaround

2e2f9df

Merge remote-tracking branch 'origin/origin/propagators' into origin/…

4476a31

…propagators # Conflicts: # api/include/opentelemetry/trace/propagation/http_trace_context.h

tracer workaround

c88cc14

Merge pull request #10 from Tianlin-Zhao/origin/propagators

2f081d8

Origin/propagators

reyang reviewed Aug 25, 2020

View reviewed changes

Tianlin-Zhao added 2 commits August 24, 2020 23:08

resolving conflicts

298cf43

resolving conflicts

e27a159

lalitb reviewed Aug 25, 2020

View reviewed changes

Tianlin-Zhao added 16 commits August 25, 2020 12:10

resolving conflicts

2a0e5b3

resolving conflicts

5b5b930

resolving conflicts

431ee66

resolving conflicts

e78ad86

resolving conflicts

16c340a

resolving conflicts

7c6cba8

resolving conflicts

5a0a40f

resolving conflicts

d6fe242

resolving conflicts

24e490d

resolving conflicts

b090657

resolving conflicts

e75105e

resolving conflicts

3fb3182

resolving conflicts

ae9485c

resolving conflicts

3da1f13

resolving conflicts

d5f869e

resolving conflicts

4b9605e

reyang reviewed Aug 25, 2020

View reviewed changes

reyang approved these changes Aug 25, 2020

View reviewed changes

reyang added the pr:please-merge This PR is ready to be merged by a Maintainer (rebased, CI passed, has enough valid approvals, etc.) label Aug 25, 2020

Tianlin-Zhao and others added 2 commits August 25, 2020 16:21

Minor change to EOF

b7d0eb4

Merge branch 'master' into origin/propagation

9a27369

reyang merged commit 09983ab into open-telemetry:master Aug 26, 2020

lalitb mentioned this pull request Aug 31, 2020

REQUEST: New membership for lalitb open-telemetry/community#464

Closed

Added Http Trace Context #143

Added Http Trace Context #143

Conversation

Tianlin-Zhao commented Jun 30, 2020 • edited Loading

linux-foundation-easycla bot commented Jun 30, 2020 • edited Loading

codecov bot commented Jun 30, 2020 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tianlin-Zhao commented Jul 7, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lalitb Aug 25, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lalitb Aug 25, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0x4b Aug 25, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ZhaoTianlin990121 Aug 25, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reyang left a comment

Choose a reason for hiding this comment

Tianlin-Zhao commented Jun 30, 2020 •

edited

Loading

linux-foundation-easycla bot commented Jun 30, 2020 •

edited

Loading

codecov bot commented Jun 30, 2020 •

edited

Loading

lalitb Aug 25, 2020 •

edited

Loading

lalitb Aug 25, 2020 •

edited

Loading

0x4b Aug 25, 2020 •

edited

Loading

ZhaoTianlin990121 Aug 25, 2020 •

edited

Loading