Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[query][api_v2/v_3] Add raw_traces parameter to GetTraceRequest and FindTracesRequest #114

Merged
merged 9 commits into from
Dec 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions proto/api_v2/query.proto
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ message GetTraceRequest {
(gogoproto.stdtime) = true,
(gogoproto.nullable) = false
];
// 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;
}

message SpansResponseChunk {
Expand Down Expand Up @@ -112,6 +116,10 @@ message TraceQueryParameters {
(gogoproto.nullable) = false
];
int32 search_depth = 8;
// 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;
yurishkuro marked this conversation as resolved.
Show resolved Hide resolved
}

message FindTracesRequest {
Expand Down
10 changes: 10 additions & 0 deletions proto/api_v3/query_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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 include 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
Expand Down Expand Up @@ -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 include 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.
Expand Down
18 changes: 18 additions & 0 deletions swagger/api_v3/query_service.swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down Expand Up @@ -183,6 +190,13 @@
"required": false,
"type": "string",
"format": "date-time"
},
{
"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.",
"in": "query",
"required": false,
"type": "boolean"
}
],
"tags": [
Expand Down Expand Up @@ -354,6 +368,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": "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."
Expand Down
Loading