Skip to content
Browse files

document thrift tracing datastructures.

  • Loading branch information...
1 parent 3efbc60 commit d095dec88a94f1b6cffbe6725878b5d71a2ad70c @mariusae mariusae committed
Showing with 17 additions and 4 deletions.
  1. +17 −4 finagle-thrift/src/main/thrift/tracing.thrift
View
21 finagle-thrift/src/main/thrift/tracing.thrift
@@ -1,9 +1,9 @@
-namespace java com.twitter.finagle.thrift
-
-/**
- * TODO: document this
+/**
+ * Define thrift structs for thrift request tracing.
*/
+namespace java com.twitter.finagle.thrift
+
struct TranscriptRecord {
1: i32 host;
2: string vm_id;
@@ -13,13 +13,26 @@ struct TranscriptRecord {
6: string message;
}
+/**
+ * TracedRequest defines trace headers. These carry the span data, and
+ * a flag indicating whether the request is to be debugged.
+ */
struct TracedRequest {
1: i64 parent_span_id;
2: bool debug;
}
+/**
+ * The TracedResponse carries a reply header for tracing. These are
+ * empty unless the request is being debugged, in which case a
+ * transcript is copied.
+ */
struct TracedResponse {
1: list<TranscriptRecord> transcript;
}
+/**
+ * These are connection-level trace options negotiated during protocol
+ * upgrade. (Intentionally left blank: for future use).
+ */
struct TraceOptions {}

0 comments on commit d095dec

Please sign in to comment.
Something went wrong with that request. Please try again.