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

Remove gogo annotations #112

Merged
merged 3 commits into from
Nov 21, 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
25 changes: 14 additions & 11 deletions proto/api_v3/query_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ syntax="proto3";
package jaeger.api_v3;

import "opentelemetry/proto/trace/v1/trace.proto";
import "gogoproto/gogo.proto";
import "google/protobuf/timestamp.proto";
import "google/protobuf/duration.proto";

Expand All @@ -28,16 +27,12 @@ option java_package = "io.jaegertracing.api_v3";
message GetTraceRequest {
// Hex encoded 64 or 128 bit trace ID.
string trace_id = 1;

// Optional. The start time to search trace ID.
google.protobuf.Timestamp start_time = 2 [
(gogoproto.stdtime) = true,
(gogoproto.nullable) = false
];
google.protobuf.Timestamp start_time = 2;

// Optional. The end time to search trace ID.
google.protobuf.Timestamp end_time = 3 [
(gogoproto.stdtime) = true,
(gogoproto.nullable) = false
];
google.protobuf.Timestamp end_time = 3;
}

// Query parameters to find traces. Except for num_traces, all fields should be treated
Expand All @@ -55,20 +50,28 @@ message GetTraceRequest {
message TraceQueryParameters {
string service_name = 1;
string operation_name = 2;

// Attributes are matched against Span and Resource attributes.
// At least one span in a trace must match all specified attributes.
map<string, string> attributes = 3;

// Span min start time in. REST API uses RFC-3339ns format. Required.
google.protobuf.Timestamp start_time_min = 4;

// Span max start time. REST API uses RFC-3339ns format. Required.
google.protobuf.Timestamp start_time_max = 5;

// Span min duration. REST API uses Golang's time format e.g. 10s.
google.protobuf.Duration duration_min = 6;

// Span max duration. REST API uses Golang's time format e.g. 10s.
google.protobuf.Duration duration_max = 7;

// Maximum number of traces in the response.
int32 num_traces = 8;
// Maximum depth of search. Depending on the backend storage
// implementtaion this could be like a regular LIMIT clause in SQL,
// but not all implementations support such accuracy and for those
// the larger depth value simply means more traces returned.
int32 search_depth = 8;
}

// Request object to search traces.
Expand Down
8 changes: 4 additions & 4 deletions swagger/api_v3/query_service.swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,8 @@
"type": "string"
},
{
"name": "query.num_traces",
"description": "Maximum number of traces in the response.",
"name": "query.search_depth",
"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.",
"in": "query",
"required": false,
"type": "integer",
Expand Down Expand Up @@ -350,10 +350,10 @@
"type": "string",
"description": "Span max duration. REST API uses Golang's time format e.g. 10s."
},
"num_traces": {
"search_depth": {
"type": "integer",
"format": "int32",
"description": "Maximum number of traces in the response."
"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."
}
},
"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