From 052bf41a8672ae9763d2943eb55d465e076975d5 Mon Sep 17 00:00:00 2001 From: Mahad Zaryab Date: Thu, 26 Dec 2024 12:05:28 -0500 Subject: [PATCH 1/9] Add raw_traces Parameter To GetTraceRequest And FindTracesRequest Signed-off-by: Mahad Zaryab --- proto/api_v2/query.proto | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/proto/api_v2/query.proto b/proto/api_v2/query.proto index 7aef8ff..493c23d 100644 --- a/proto/api_v2/query.proto +++ b/proto/api_v2/query.proto @@ -50,6 +50,9 @@ message GetTraceRequest { (gogoproto.stdtime) = true, (gogoproto.nullable) = false ]; + // Optional. If set to true, the response will not perform any + // adjustments to the trace. + bool raw_traces = 4; } message SpansResponseChunk { @@ -112,6 +115,7 @@ message TraceQueryParameters { (gogoproto.nullable) = false ]; int32 search_depth = 8; + bool raw_traces = 9; } message FindTracesRequest { From ee699d66cf3825506b1d936bad18ebff258c413f Mon Sep 17 00:00:00 2001 From: Mahad Zaryab Date: Thu, 26 Dec 2024 12:17:18 -0500 Subject: [PATCH 2/9] Address Feedback Signed-off-by: Mahad Zaryab --- proto/api_v2/query.proto | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/proto/api_v2/query.proto b/proto/api_v2/query.proto index 493c23d..ab634bb 100644 --- a/proto/api_v2/query.proto +++ b/proto/api_v2/query.proto @@ -51,7 +51,8 @@ message GetTraceRequest { (gogoproto.nullable) = false ]; // Optional. If set to true, the response will not perform any - // adjustments to the trace. + // enrichments to the trace, such as clock skew adjustment. + // Instead, the trace will be returned exactly as stored. bool raw_traces = 4; } From e26cbfedf7931b939bb5cfbf643e28866a9018f5 Mon Sep 17 00:00:00 2001 From: Mahad Zaryab Date: Thu, 26 Dec 2024 12:45:31 -0500 Subject: [PATCH 3/9] Add Documentation Signed-off-by: Mahad Zaryab --- proto/api_v2/query.proto | 3 +++ 1 file changed, 3 insertions(+) diff --git a/proto/api_v2/query.proto b/proto/api_v2/query.proto index ab634bb..d859b5e 100644 --- a/proto/api_v2/query.proto +++ b/proto/api_v2/query.proto @@ -116,6 +116,9 @@ message TraceQueryParameters { (gogoproto.nullable) = false ]; int32 search_depth = 8; + // Optional. If set to true, the response will not perform any + // enrichments to the trace, such as clock skew adjustment. + // Instead, the trace will be returned exactly as stored. bool raw_traces = 9; } From c34879bad9685fe76e72e85e0bacc302108ce491 Mon Sep 17 00:00:00 2001 From: Mahad Zaryab Date: Thu, 26 Dec 2024 12:51:19 -0500 Subject: [PATCH 4/9] Add raw_traces Parameter To GetTraceRequest And FindTracesRequest Signed-off-by: Mahad Zaryab --- proto/api_v3/query_service.proto | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/proto/api_v3/query_service.proto b/proto/api_v3/query_service.proto index d4b1bb8..55ac766 100644 --- a/proto/api_v3/query_service.proto +++ b/proto/api_v3/query_service.proto @@ -33,6 +33,11 @@ message GetTraceRequest { // Optional. The end time to search trace ID. google.protobuf.Timestamp end_time = 3; + + // Optional. If set to true, the response will not perform any + // enrichments to the trace, such as clock skew adjustment. + // Instead, the trace will be returned exactly as stored. + bool raw_traces = 4; } // Query parameters to find traces. Except for num_traces, all fields should be treated @@ -72,6 +77,11 @@ message TraceQueryParameters { // but not all implementations support such accuracy and for those // the larger depth value simply means more traces returned. int32 search_depth = 8; + + // Optional. If set to true, the response will not perform any + // enrichments to the trace, such as clock skew adjustment. + // Instead, the trace will be returned exactly as stored. + bool raw_traces = 9; } // Request object to search traces. From f526d357e3d0f50fd9676118a0251af0dd78617f Mon Sep 17 00:00:00 2001 From: Mahad Zaryab Date: Thu, 26 Dec 2024 12:58:18 -0500 Subject: [PATCH 5/9] Update Swagger Documentation Signed-off-by: Mahad Zaryab --- swagger/api_v3/query_service.swagger.json | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/swagger/api_v3/query_service.swagger.json b/swagger/api_v3/query_service.swagger.json index b7829cd..e5ed58f 100644 --- a/swagger/api_v3/query_service.swagger.json +++ b/swagger/api_v3/query_service.swagger.json @@ -183,6 +183,13 @@ "required": false, "type": "string", "format": "date-time" + }, + { + "name": "raw_traces", + "description": "If set to true, the response will not perform any enrichments to the trace, such as clock skew adjustment. Instead, the trace will be returned exactly as stored.", + "in": "query", + "required": false, + "type": "boolean" } ], "tags": [ @@ -354,6 +361,10 @@ "type": "integer", "format": "int32", "description": "Maximum depth of search. Depending on the backend storage\nimplementtaion this could be like a regular LIMIT clause in SQL,\nbut not all implementations support such accuracy and for those\nthe larger depth value simply means more traces returned." + }, + "raw_traces": { + "type": "boolean", + "description": "If set to true, the response will not perform any enrichments to the trace, such as clock skew adjustment. Instead, the trace will be returned exactly as stored." } }, "description": "Query parameters to find traces. Except for num_traces, all fields should be treated\nas forming a conjunction, e.g., \"service_name='X' AND operation_name='Y' AND ...\".\nAll fields are matched against individual spans, not at the trace level.\nThe returned results contain traces where at least one span matches the conditions.\nWhen num_traces results in fewer traces returned, there is no required ordering.\n\nNote: num_traces should restrict the number of traces returned, but not all backends\ninterpret it this way. For instance, in Cassandra this limits the number of _spans_\nthat match the conditions, and the resulting number of traces can be less.\n\nNote: some storage implementations do not guarantee the correct implementation of all parameters." From 26ece1da3e5b3b5010cffe5e00c8b43b49867c70 Mon Sep 17 00:00:00 2001 From: Mahad Zaryab Date: Thu, 26 Dec 2024 13:03:31 -0500 Subject: [PATCH 6/9] Fix Documentation Signed-off-by: Mahad Zaryab --- proto/api_v3/query_service.proto | 2 +- swagger/api_v3/query_service.swagger.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/proto/api_v3/query_service.proto b/proto/api_v3/query_service.proto index 55ac766..e0e0a4c 100644 --- a/proto/api_v3/query_service.proto +++ b/proto/api_v3/query_service.proto @@ -78,7 +78,7 @@ message TraceQueryParameters { // the larger depth value simply means more traces returned. int32 search_depth = 8; - // Optional. If set to true, the response will not perform any + // If set to true, the response will not perform any // enrichments to the trace, such as clock skew adjustment. // Instead, the trace will be returned exactly as stored. bool raw_traces = 9; diff --git a/swagger/api_v3/query_service.swagger.json b/swagger/api_v3/query_service.swagger.json index e5ed58f..b657089 100644 --- a/swagger/api_v3/query_service.swagger.json +++ b/swagger/api_v3/query_service.swagger.json @@ -186,7 +186,7 @@ }, { "name": "raw_traces", - "description": "If set to true, the response will not perform any enrichments to the trace, such as clock skew adjustment. Instead, the trace will be returned exactly as stored.", + "description": "Optional. If set to true, the response will not perform any enrichments to the trace, such as clock skew adjustment. Instead, the trace will be returned exactly as stored.", "in": "query", "required": false, "type": "boolean" From 49fd7160aa55d5d000d622f5c4a7f374d6ec14dc Mon Sep 17 00:00:00 2001 From: Mahad Zaryab Date: Thu, 26 Dec 2024 13:07:51 -0500 Subject: [PATCH 7/9] Fix Documentation Signed-off-by: Mahad Zaryab --- swagger/api_v3/query_service.swagger.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/swagger/api_v3/query_service.swagger.json b/swagger/api_v3/query_service.swagger.json index b657089..3b53570 100644 --- a/swagger/api_v3/query_service.swagger.json +++ b/swagger/api_v3/query_service.swagger.json @@ -186,7 +186,7 @@ }, { "name": "raw_traces", - "description": "Optional. If set to true, the response will not perform any enrichments to the trace, such as clock skew adjustment. Instead, the trace will be returned exactly as stored.", + "description": "Optional. If set to true, the response will not perform any \nenrichments to the trace, such as clock skew adjustment.\nInstead, the trace will be returned exactly as stored.", "in": "query", "required": false, "type": "boolean" @@ -364,7 +364,7 @@ }, "raw_traces": { "type": "boolean", - "description": "If set to true, the response will not perform any enrichments to the trace, such as clock skew adjustment. Instead, the trace will be returned exactly as stored." + "description": "If set to true, the response will not perform any \nenrichments to the trace, such as clock skew adjustment.\nInstead, the trace will be returned exactly as stored." } }, "description": "Query parameters to find traces. Except for num_traces, all fields should be treated\nas forming a conjunction, e.g., \"service_name='X' AND operation_name='Y' AND ...\".\nAll fields are matched against individual spans, not at the trace level.\nThe returned results contain traces where at least one span matches the conditions.\nWhen num_traces results in fewer traces returned, there is no required ordering.\n\nNote: num_traces should restrict the number of traces returned, but not all backends\ninterpret it this way. For instance, in Cassandra this limits the number of _spans_\nthat match the conditions, and the resulting number of traces can be less.\n\nNote: some storage implementations do not guarantee the correct implementation of all parameters." From 194a9819da5a55b92f0c14d5c7d08216b4550512 Mon Sep 17 00:00:00 2001 From: Yuri Shkuro Date: Thu, 26 Dec 2024 13:12:21 -0500 Subject: [PATCH 8/9] fix Signed-off-by: Yuri Shkuro --- proto/api_v2/query.proto | 4 ++-- proto/api_v3/query_service.proto | 4 ++-- swagger/api_v3/query_service.swagger.json | 11 +++++++++-- 3 files changed, 13 insertions(+), 6 deletions(-) diff --git a/proto/api_v2/query.proto b/proto/api_v2/query.proto index d859b5e..3b047f6 100644 --- a/proto/api_v2/query.proto +++ b/proto/api_v2/query.proto @@ -50,7 +50,7 @@ message GetTraceRequest { (gogoproto.stdtime) = true, (gogoproto.nullable) = false ]; - // Optional. If set to true, the response will not perform any + // Optional. If set to true, the response will not include any // enrichments to the trace, such as clock skew adjustment. // Instead, the trace will be returned exactly as stored. bool raw_traces = 4; @@ -116,7 +116,7 @@ message TraceQueryParameters { (gogoproto.nullable) = false ]; int32 search_depth = 8; - // Optional. If set to true, the response will not perform any + // Optional. If set to true, the response will not include any // enrichments to the trace, such as clock skew adjustment. // Instead, the trace will be returned exactly as stored. bool raw_traces = 9; diff --git a/proto/api_v3/query_service.proto b/proto/api_v3/query_service.proto index e0e0a4c..517ac2e 100644 --- a/proto/api_v3/query_service.proto +++ b/proto/api_v3/query_service.proto @@ -34,7 +34,7 @@ message GetTraceRequest { // Optional. The end time to search trace ID. google.protobuf.Timestamp end_time = 3; - // Optional. If set to true, the response will not perform any + // Optional. If set to true, the response will not include any // enrichments to the trace, such as clock skew adjustment. // Instead, the trace will be returned exactly as stored. bool raw_traces = 4; @@ -78,7 +78,7 @@ message TraceQueryParameters { // the larger depth value simply means more traces returned. int32 search_depth = 8; - // If set to true, the response will not perform any + // Optional. If set to true, the response will not include any // enrichments to the trace, such as clock skew adjustment. // Instead, the trace will be returned exactly as stored. bool raw_traces = 9; diff --git a/swagger/api_v3/query_service.swagger.json b/swagger/api_v3/query_service.swagger.json index 3b53570..81f2474 100644 --- a/swagger/api_v3/query_service.swagger.json +++ b/swagger/api_v3/query_service.swagger.json @@ -132,6 +132,13 @@ "required": false, "type": "integer", "format": "int32" + }, + { + "name": "query.raw_traces", + "description": "Optional. If set to true, the response will not include any \nenrichments to the trace, such as clock skew adjustment.\nInstead, the trace will be returned exactly as stored.", + "in": "query", + "required": false, + "type": "boolean" } ], "tags": [ @@ -186,7 +193,7 @@ }, { "name": "raw_traces", - "description": "Optional. If set to true, the response will not perform any \nenrichments to the trace, such as clock skew adjustment.\nInstead, the trace will be returned exactly as stored.", + "description": "Optional. If set to true, the response will not include any \nenrichments to the trace, such as clock skew adjustment.\nInstead, the trace will be returned exactly as stored.", "in": "query", "required": false, "type": "boolean" @@ -364,7 +371,7 @@ }, "raw_traces": { "type": "boolean", - "description": "If set to true, the response will not perform any \nenrichments to the trace, such as clock skew adjustment.\nInstead, the trace will be returned exactly as stored." + "description": "Optional. If set to true, the response will not include any \nenrichments to the trace, such as clock skew adjustment.\nInstead, the trace will be returned exactly as stored." } }, "description": "Query parameters to find traces. Except for num_traces, all fields should be treated\nas forming a conjunction, e.g., \"service_name='X' AND operation_name='Y' AND ...\".\nAll fields are matched against individual spans, not at the trace level.\nThe returned results contain traces where at least one span matches the conditions.\nWhen num_traces results in fewer traces returned, there is no required ordering.\n\nNote: num_traces should restrict the number of traces returned, but not all backends\ninterpret it this way. For instance, in Cassandra this limits the number of _spans_\nthat match the conditions, and the resulting number of traces can be less.\n\nNote: some storage implementations do not guarantee the correct implementation of all parameters." From bb282bf8a0c74b404555456f5e85cacec0e5c0ee Mon Sep 17 00:00:00 2001 From: Yuri Shkuro Date: Thu, 26 Dec 2024 13:14:44 -0500 Subject: [PATCH 9/9] regenerate Signed-off-by: Yuri Shkuro --- swagger/api_v3/query_service.swagger.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/swagger/api_v3/query_service.swagger.json b/swagger/api_v3/query_service.swagger.json index 81f2474..4d400d8 100644 --- a/swagger/api_v3/query_service.swagger.json +++ b/swagger/api_v3/query_service.swagger.json @@ -135,7 +135,7 @@ }, { "name": "query.raw_traces", - "description": "Optional. If set to true, the response will not include any \nenrichments to the trace, such as clock skew adjustment.\nInstead, the trace will be returned exactly as stored.", + "description": "Optional. If set to true, the response will not include any\nenrichments to the trace, such as clock skew adjustment.\nInstead, the trace will be returned exactly as stored.", "in": "query", "required": false, "type": "boolean" @@ -193,7 +193,7 @@ }, { "name": "raw_traces", - "description": "Optional. If set to true, the response will not include any \nenrichments to the trace, such as clock skew adjustment.\nInstead, the trace will be returned exactly as stored.", + "description": "Optional. If set to true, the response will not include any\nenrichments to the trace, such as clock skew adjustment.\nInstead, the trace will be returned exactly as stored.", "in": "query", "required": false, "type": "boolean" @@ -371,7 +371,7 @@ }, "raw_traces": { "type": "boolean", - "description": "Optional. If set to true, the response will not include any \nenrichments to the trace, such as clock skew adjustment.\nInstead, the trace will be returned exactly as stored." + "description": "Optional. If set to true, the response will not include any\nenrichments to the trace, such as clock skew adjustment.\nInstead, the trace will be returned exactly as stored." } }, "description": "Query parameters to find traces. Except for num_traces, all fields should be treated\nas forming a conjunction, e.g., \"service_name='X' AND operation_name='Y' AND ...\".\nAll fields are matched against individual spans, not at the trace level.\nThe returned results contain traces where at least one span matches the conditions.\nWhen num_traces results in fewer traces returned, there is no required ordering.\n\nNote: num_traces should restrict the number of traces returned, but not all backends\ninterpret it this way. For instance, in Cassandra this limits the number of _spans_\nthat match the conditions, and the resulting number of traces can be less.\n\nNote: some storage implementations do not guarantee the correct implementation of all parameters."