Skip to content

Commit

Permalink
Address Feedback
Browse files Browse the repository at this point in the history
Signed-off-by: Mahad Zaryab <mahadzaryab1@gmail.com>
  • Loading branch information
mahadzaryab1 committed Feb 17, 2025
1 parent 27a09b3 commit fa57356
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
15 changes: 8 additions & 7 deletions proto/api_v3/query_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,16 @@ message GetTraceRequest {
bool raw_traces = 4;
}

// Query parameters to find traces. All fields should be treated
// as forming a conjunction, e.g., "service_name='X' AND operation_name='Y' AND ...",
// with the exception of `search_depth` and `raw_traces`.
// Query parameters to find traces.
//
// All fields are matched against individual spans, not at the trace level.
// The returned results contain traces where at least one span matches the conditions.
// There is no guaranteed ordering of the returned results.
// All fields form a conjunction (e.g., "service_name='X' AND operation_name='Y' AND ..."),
// except for `search_depth` and `raw_traces`.
//
// Note: Some storage implementations do not guarantee the correct implementation of all parameters.
// Fields are matched against individual spans, not the trace level. The results include
// traces with at least one matching span.
//
// The results have no guaranteed ordering. Additionally, some storage implementations
// may not fully support all parameters.
message TraceQueryParameters {
// `service_name` filters traces generated by a specific service.
string service_name = 1;
Expand Down
2 changes: 1 addition & 1 deletion swagger/api_v3/query_service.swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@
"description": "If set to true, the response will exclude any enrichments to the trace, such as clock skew adjustments.\nThe trace will be returned exactly as stored.\n\nThis field is optional."
}
},
"description": "Query parameters to find traces. All fields should be treated\nas forming a conjunction, e.g., \"service_name='X' AND operation_name='Y' AND ...\",\nwith the exception of `search_depth` and `raw_traces`.\n\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.\nThere is no guaranteed ordering of the returned results.\n\nNote: Some storage implementations do not guarantee the correct implementation of all parameters."
"description": "Query parameters to find traces.\n\nAll fields form a conjunction (e.g., \"service_name='X' AND operation_name='Y' AND ...\"),\nexcept for `search_depth` and `raw_traces`.\n\nFields are matched against individual spans, not the trace level. The results include\ntraces with at least one matching span.\n\nThe results have no guaranteed ordering. Additionally, some storage implementations\nmay not fully support all parameters."
},
"protobufAny": {
"type": "object",
Expand Down

0 comments on commit fa57356

Please sign in to comment.