package jaeger.api_v3

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc FindTraceSummaries (FindTraceSummariesRequest, stream FindTraceSummariesResponse)

  query_service.proto:290

  FindTraceSummaries searches for traces matching the given query and streams back lightweight summary information for each matching trace. Each response chunk may contain one or more summaries. Use this instead of FindTraces when full span data is not required (e.g. search results page).

  message FindTraceSummariesRequest

  query_service.proto:221

  Request object for FindTraceSummaries.

  • optional TraceQueryParameters query = 1

  message FindTraceSummariesResponse

  query_service.proto:228

  Response chunk for FindTraceSummaries. A single RPC call may yield multiple chunks, each carrying one or more summaries, mirroring the chunked streaming used by FindTraces / GetTrace.

  • repeated TraceSummary summaries = 1

• rpc FindTraces (FindTracesRequest, stream opentelemetry.proto.trace.v1.TracesData)

  query_service.proto:246

  FindTraces searches for traces. See GetTrace for JSON unmarshalling.

  message FindTracesRequest

  query_service.proto:116

  Request object to search traces.

  • optional TraceQueryParameters query = 1

• rpc GetDependencies (GetDependenciesRequest, DependenciesResponse)

  query_service.proto:280

  message GetDependenciesRequest

  query_service.proto:147

  • optional google.protobuf.Timestamp start_time = 1

    Required. The start time for the time range to search dependencies.

  • optional google.protobuf.Timestamp end_time = 2

    Required. The end time for the time range to search dependencies.

  message DependenciesResponse

  query_service.proto:156

  • repeated Dependency dependencies = 1

• rpc GetOperations (GetOperationsRequest, GetOperationsResponse)

  query_service.proto:275

  GetOperations returns operation names.

  message GetOperationsRequest

  query_service.proto:129

  Request object to get operation names.

  • string service = 1

    Required service name.

  • string span_kind = 2

    Optional span kind.

  message GetOperationsResponse

  query_service.proto:143

  Response object to get operation names.

  • repeated Operation operations = 1

• rpc GetServices (GetServicesRequest, GetServicesResponse)

  query_service.proto:268

  GetServices returns service names.

  message GetServicesRequest

  query_service.proto:121

  Request object to get service names.

  (message has no fields)

  message GetServicesResponse

  query_service.proto:124

  Response object to get service names.

  • repeated string services = 1

• rpc GetTrace (GetTraceRequest, stream opentelemetry.proto.trace.v1.TracesData)

  query_service.proto:238

  GetTrace returns a single trace. Note that the JSON response over HTTP is wrapped into result envelope "{"result": ...}" It means that the JSON response cannot be directly unmarshalled using JSONPb. This can be fixed by first parsing into user-defined envelope with standard JSON library or string manipulation to remove the envelope. Alternatively generate objects using OpenAPI.

  message GetTraceRequest

  query_service.proto:30

  Request object to get a trace.

  • string trace_id = 1

    Hex encoded 64 or 128 bit trace ID.

  • optional google.protobuf.Timestamp start_time = 2

    Optional. The start time to search trace ID.

  • optional google.protobuf.Timestamp end_time = 3

    Optional. The end time to search trace ID.

  • bool raw_traces = 4

    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.

Used in: DependenciesResponse

• string parent = 1

• string child = 2

• uint64 call_count = 3

GRPCGatewayError is the type returned when GRPC server returns an error. Example: {"error":{"grpcCode":2,"httpCode":500,"message":"...","httpStatus":"text..."}}.

• optional GRPCGatewayError.GRPCGatewayErrorDetails error = 1

Used in: GRPCGatewayError

• int32 grpcCode = 1

• int32 httpCode = 2

• string message = 3

• string httpStatus = 4

GRPCGatewayWrapper wraps streaming responses from GetTrace/FindTraces for HTTP. Today there is always only one response because internally the HTTP server gets data from QueryService that does not support multiple responses. But in the future the server may return multiple responeses using Transfer-Encoding: chunked. In case of errors, GRPCGatewayError above is used. Example: {"result": {"resourceSpans": ...}} See https://github.com/grpc-ecosystem/grpc-gateway/issues/2189

• optional opentelemetry.proto.trace.v1.TracesData result = 1

Operation encapsulates information about operation.

Used in: GetOperationsResponse

• string name = 1

• string span_kind = 2

ServiceSummary contains per-service statistics for a trace, matching what the UI renders as a coloured tag in the search results row.

Used in: TraceSummary

• string name = 1

  Name of the service.

• int32 span_count = 2

  Number of spans attributed to this service in the trace.

• int32 error_span_count = 3

  Number of spans from this service that carry OTEL StatusCode = ERROR. The UI renders an error icon when this value is > 0. Only spans explicitly owned by this service are counted; there is no error propagation from child spans of other services.

Query parameters to find traces. All fields form a conjunction (e.g., "service_name='X' AND operation_name='Y' AND ..."), except for `search_depth` and `raw_traces`. 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.

Used in: FindTraceSummariesRequest, FindTracesRequest

• string service_name = 1

  service_name filters spans generated by a specific service.

• string operation_name = 2

  operation_name filters spans by a specific operation / span name.

• map<string, string> attributes = 3

  attributes contains key-value pairs where the key is the attribute name and the value is its string representation. Attributes are matched against span and resource attributes. At least one span must match all specified attributes. The HTTP API expects this as a URL-encoded JSON string map. Example: {"http.status_code":"200","error":"true"}

• optional google.protobuf.Timestamp start_time_min = 4

  start_time_min is the start of the time interval (inclusive) for the query. Only traces with spans that started on or after this time will be returned. The HTTP API uses RFC-3339ns format. This field is required.

• optional google.protobuf.Timestamp start_time_max = 5

  start_time_max is the end of the time interval (exclusive) for the query. Only traces with spans that started before this time will be returned. The HTTP API uses RFC-3339ns format. This field is required.

• optional google.protobuf.Duration duration_min = 6

  duration_min is the minimum duration of a span in the trace. Only traces with spans that lasted at least this long will be returned. The HTTP API uses Golang's time format (e.g., "10s").

• optional google.protobuf.Duration duration_max = 7

  duration_max is the maximum duration of a span in the trace. Only traces with spans that lasted at most this long will be returned. The HTTP API uses Golang's time format (e.g., "10s").

• int32 search_depth = 8

  search_depth defines the maximum search depth. Depending on the backend storage implementation, this may behave like an SQL `LIMIT` clause. However, some implementations might not support precise limits, and a larger value generally results in more traces being returned.

• bool raw_traces = 9

  If set to true, the response will exclude any enrichments to the trace, such as clock skew adjustments. The trace will be returned exactly as stored. This field is optional.

TraceSummary contains lightweight summary information about a trace, suitable for display in search result lists.

Used in: FindTraceSummariesResponse

• string trace_id = 1

  Hex-encoded 128-bit trace ID.

• string root_service_name = 2

  Name of the service that owns the root span.

• string root_operation_name = 3

  Operation name of the root span.

• fixed64 min_start_time_unix_nano = 4

  Start timestamp of the earliest span in the trace (Unix nanoseconds). Named to match the OTLP convention (e.g. startTimeUnixNano in OTLP span JSON). proto3 JSON encoding: fixed64/uint64/int64 fields are serialised as decimal strings to avoid float64 precision loss in JavaScript for values above 2^53.

• fixed64 max_end_time_unix_nano = 5

  End timestamp of the latest span in the trace (Unix nanoseconds). The UI may compute duration as BigInt(maxEndTimeUnixNano) - BigInt(minStartTimeUnixNano).

• int32 span_count = 6

  Total number of spans in the trace.

• int32 error_span_count = 7

  Number of spans that carry an error indicator (OTEL StatusCode = ERROR).

• int32 orphan_span_count = 8

  Number of spans whose parent span ID is not present in this trace. A non-zero value indicates an incomplete or partial trace.

• repeated ServiceSummary services = 9

  Per-service breakdown, one entry per distinct service name observed across all spans, sorted by name.