xray: Use correct types for segment document output #10834

dastbe · 2020-04-17T21:19:22Z

Description: Switches X-Ray tracing plugin to use proto3 structs, which emit correctly typed outputs (String for StringValue, Number for NumberValue, etc.) such that X-Ray will process those fields.
Risk Level: Low
Testing: unit-tests, manual
Docs Changes: N/A
Release Notes: N/A
Fixes: #10814

manual verification via a udpdump script

received message: 
{
  "format": "json",
  "version": 1
}
{
  "name": "test",
  "id": "0001db556b0a4300",
  "trace_id": "1-5e98e9bb-1d9f337ee5da4242b7c90aa5",
  "start_time": 1587079611.7999656,
  "end_time": 1587079611.803993,
  "http": {
    "request": {
      "method": "GET",
      "x_forwarded_for": false,
      "url": "http://localhost:8080/",
      "user_agent": "curl/7.58.0",
      "client_ip": "127.0.0.1"
    },
    "response": {
      "content_length": 976,
      "status": 200
    }
  },
  "annotations": {
    "downstream_cluster": "-",
    "response_flags": "-",
    "request_size": "0",
    "upstream_cluster": "service1",
    "guid:x-request-id": "7f35dadf-d8b9-9798-a97e-21e2c759ce11",
    "http.protocol": "HTTP/1.1",
    "node_id": "abc_id",
    "component": "proxy"
  }
}

Signed-off-by: David Bell <belldav@amazon.com>

…retain type information Risk Level: Low Testing: unit tests, manual Docs Changes: N/A Release Notes: N/A Fixes: envoyproxy#10814 Signed-off-by: David Bell <belldav@amazon.com>

mattklein123 · 2020-04-18T22:00:43Z

@marcomagdy for first pass. Also, please substantially improve xray coverage here: https://storage.googleapis.com/envoy-coverage/report-master/index.html. There is a lot missing. Thank you!

/wait

Signed-off-by: David Bell <belldav@amazon.com>

marcomagdy

Thank you for taking care of this. I left some comments.

marcomagdy · 2020-04-21T17:00:16Z

source/extensions/tracers/xray/tracer.cc

+ daemon::Segment_http_annotations* http = s.mutable_http();
+
+ ProtobufWkt::Struct* request = http->mutable_request();
+ auto request_fields = request->mutable_fields();


nit: auto* instead of auto when the deduced type is a pointer.

marcomagdy · 2020-04-21T17:04:22Z

source/extensions/tracers/xray/tracer.cc

+ for (const auto& field : http_request_annotations_) {
+ request_fields->insert(StructField{field.first, field.second});
+
+ (*request_fields)[field.first] = field.second;


This line is a duplicate. remove?

bleh, looking at this and cout it looks like I didn't look at my rebase merge closely enough. fixed.

marcomagdy · 2020-04-21T17:06:32Z

source/extensions/tracers/xray/tracer.cc

@@ -179,20 +191,31 @@ void Span::setTag(absl::string_view name, absl::string_view value) {
 }

 if (name == HttpUrl) {
- http_request_annotations_.emplace(SpanUrl, value);
+ http_request_annotations_.emplace(SpanUrl, ValueUtil::stringValue(std::string(value)));


value is a string already.
so this should be ValueUtil::stringValue(value); instead?

So value is a string_view, and based off my read of the abseil docs and the header there is no implicit conversion from string_view to string. As rusty as I am at c++, I'm assuming the reason the "implicit conversion" works for flat_hash_map::emplace is because its constructing from arguments internally

if value is a string_view, then this is fine.

marcomagdy · 2020-04-21T17:06:59Z

source/extensions/tracers/xray/tracer.cc

 } else if (name == HttpStatusCode) {
- http_response_annotations_.emplace(SpanStatus, value);
+ uint64_t status_code;
+ std::cout << "belldav" << value << std::endl;


😬, removed.

marcomagdy · 2020-04-21T17:14:43Z

source/extensions/tracers/xray/tracer.cc

+ if (!absl::SimpleAtoi(value, &status_code)) {
+ ENVOY_LOG(warn, "{} must be a number, given: {}", HttpStatusCode, value);
+ return;
+ }


Rather than discard the entire trace, it's better just to skip the status if we can't parse it.

Also, Matt is likely to have you change this log verbosity to debug or trace.

setTag only operates on a single key-value pair, so this won't fail the entire trace.

I could however see failing to parse falling back to registering a custom annotation with these values.

You're right. I confused this with the code in finishSpan().

I did drop the log level down to debug.

marcomagdy · 2020-04-21T17:18:14Z

source/extensions/tracers/xray/tracer.cc

+ uint64_t response_size;
+ if (!absl::SimpleAtoi(value, &response_size)) {
+ ENVOY_LOG(warn, "{} must be a number, given: {}", HttpResponseSize, value);
+ return;
+ }
+ http_response_annotations_.emplace(SpanContentLength, ValueUtil::numberValue(response_size));


~~same as above. change log verbosity, and skip just the value.~~

marcomagdy · 2020-04-21T17:21:22Z

source/extensions/tracers/xray/tracer.cc

+ daemon::Segment_http_annotations* http = s.mutable_http();
+
+ ProtobufWkt::Struct* request = http->mutable_request();


I'd change those two lines to:

ProtobufWkt::Struct* request = s.http()->mutable_request();

The http is not used anywhere else.

makes sense. this was left over from my misunderstanding that constructing submessages and assigning isn't the right way to go in c++.

marcomagdy · 2020-04-21T17:24:15Z

source/common/protobuf/utility.h

+ /**
+ * Wrap double into ProtobufWkt::Value string value.
+ * @param d double to be wrapped.
+ * @return wrapped double.
+ */
+ static ProtobufWkt::Value numberValue(const double str);
+


There's already a numberValue(..) utility function on line 459.
You can remove this function and its definition.

Signed-off-by: David Bell <belldav@amazon.com>

This reverts commit ecd5844. Signed-off-by: David Bell <belldav@amazon.com>

Signed-off-by: David Bell <belldav@amazon.com>

marcomagdy

LGTM. Thanks.

@mattklein123 I have a separate PR for improving the test coverage here #10890

mattklein123

Thanks!

Risk Level: Low Testing: unit tests, manual Docs Changes: N/A Release Notes: N/A Fixes: envoyproxy#10814 Signed-off-by: pengg <pengg@google.com>

Signed-off-by: Spencer Lewis <slewis@squareup.com> * master: (46 commits) allow specifying the API version of bootstrap from the command line (envoyproxy#10803) config: adding connect matcher (unused) (envoyproxy#10894) Add missing dependency on `assert.h` (envoyproxy#10918) Lower heap and disk space used by kafka tests (envoyproxy#10915) [tools] handle commits merged without PR in deprecated script (envoyproxy#10723) tools: including working tree in modified_since_last_github_commit.sh diff. (envoyproxy#10911) rocketmq_proxy: implement rocketmq proxy [docs] PR template to include commit message (envoyproxy#10900) docs: breaking long word to stop content overflow. (envoyproxy#10880) Delete legacy connection pool code. (envoyproxy#10881) wasm: clarify how configuration is passed (envoyproxy#10782) issue template: clarify security/crash reporting (envoyproxy#10885) api/faq: add entry on incremental xDS. (envoyproxy#10876) router: retry overloaded requests (envoyproxy#10847) Remove inclusion of pthread.h, not needed for linux compilation (envoyproxy#10895) request_id: Add option to always set request id in response (envoyproxy#10808) xray: Use correct types for segment document output (envoyproxy#10834) router: fixing a watermark bug for streaming retries (envoyproxy#10866) http: auditing Path() calls for safety with Pathless CONNECT (envoyproxy#10851) Remove hardcoded type urls Part.2 (envoyproxy#10848) ...

David Bell added 2 commits April 17, 2020 20:56

utility: Add numberValue constructor proto utility functions

ecd5844

Signed-off-by: David Bell <belldav@amazon.com>

xray: Convert http request/response annotations to proto3 structs to …

91ab2b1

…retain type information Risk Level: Low Testing: unit tests, manual Docs Changes: N/A Release Notes: N/A Fixes: envoyproxy#10814 Signed-off-by: David Bell <belldav@amazon.com>

dastbe requested a review from mattklein123 as a code owner April 17, 2020 21:19

mattklein123 assigned marcomagdy and mattklein123 Apr 18, 2020

repokitteh-read-only bot added the waiting label Apr 18, 2020

clang is less permissive about captures than gcc

a9c6aa6

Signed-off-by: David Bell <belldav@amazon.com>

repokitteh-read-only bot removed the waiting label Apr 20, 2020

mattklein123 added the waiting:any label Apr 21, 2020

marcomagdy suggested changes Apr 21, 2020

View reviewed changes

repokitteh-read-only bot removed the waiting:any label Apr 21, 2020

mattklein123 added the waiting label Apr 21, 2020

David Bell added 3 commits April 21, 2020 19:13

review comments

239b76a

Signed-off-by: David Bell <belldav@amazon.com>

Revert "utility: Add numberValue constructor proto utility functions"

39c8e05

This reverts commit ecd5844. Signed-off-by: David Bell <belldav@amazon.com>

drop log level to debug

79ffe41

Signed-off-by: David Bell <belldav@amazon.com>

repokitteh-read-only bot removed the waiting label Apr 21, 2020

drop redundant insert

b3b9cf5

Signed-off-by: David Bell <belldav@amazon.com>

mattklein123 added the waiting:any label Apr 21, 2020

repokitteh-read-only bot removed the waiting:any label Apr 21, 2020

marcomagdy approved these changes Apr 22, 2020

View reviewed changes

mattklein123 approved these changes Apr 22, 2020

View reviewed changes

mattklein123 merged commit ad31f1c into envoyproxy:master Apr 22, 2020

dastbe mentioned this pull request Sep 11, 2020

How to get "response" data in the HTTP trace at the proxy level #13059

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

xray: Use correct types for segment document output #10834

xray: Use correct types for segment document output #10834

dastbe commented Apr 17, 2020

mattklein123 commented Apr 18, 2020

marcomagdy left a comment

marcomagdy Apr 21, 2020

dastbe Apr 21, 2020

marcomagdy Apr 21, 2020

dastbe Apr 21, 2020

marcomagdy Apr 21, 2020

dastbe Apr 21, 2020

marcomagdy Apr 21, 2020

marcomagdy Apr 21, 2020

dastbe Apr 21, 2020

marcomagdy Apr 21, 2020

dastbe Apr 21, 2020

marcomagdy Apr 21, 2020 •

edited

Loading

dastbe Apr 21, 2020

marcomagdy Apr 21, 2020 •

edited

Loading

marcomagdy Apr 21, 2020

dastbe Apr 21, 2020

marcomagdy Apr 21, 2020

dastbe Apr 21, 2020

marcomagdy left a comment

mattklein123 left a comment

		daemon::Segment_http_annotations* http = s.mutable_http();

		ProtobufWkt::Struct* request = http->mutable_request();

xray: Use correct types for segment document output #10834

xray: Use correct types for segment document output #10834

Conversation

dastbe commented Apr 17, 2020

mattklein123 commented Apr 18, 2020

marcomagdy left a 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

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

marcomagdy Apr 21, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcomagdy Apr 21, 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

marcomagdy left a comment

Choose a reason for hiding this comment

mattklein123 left a comment

Choose a reason for hiding this comment

marcomagdy Apr 21, 2020 •

edited

Loading

marcomagdy Apr 21, 2020 •

edited

Loading