Files
Andreas GerstmayrandGitHub f8fcfaf0ff Fix GetTrace() in tempo-query (#5864)
* Fix GetTrace() in tempo-query

Upgrading to grpc 1.38.0 broke compatibility with gogoproto.customtype,
and the trace_id field in GetTraceRequest of storage.pb.go uses customtype.

This issue only occurs when navigating to a trace in Jaeger UI and
then hitting refresh (this triggers a GetTrace() request).
Searching traces in Jaeger UI and opening them worked fine before this
change as well, because this issued a FindTraces() request, which doesn't
use a customtype.

* add changelog entry

Signed-off-by: Andreas Gerstmayr <[email protected]>

---------

Signed-off-by: Andreas Gerstmayr <[email protected]>
2025-11-06 16:49:28 +01:00

75 lines
2.8 KiB
Go

// This is copied over from Jaeger and modified to work for Tempo
// Upgrading to grpc 1.38.0 broke compatibility with gogoproto.customtype. (https://github.com/grpc/grpc-go/issues/4192)
// We use a customtype in the ingesters to pre-allocate byte slices that are reused for requests.
// Similarly Jaeger and Cortex use gogo's custom types for efficiency.
// gogoproto codec is needed only if a custom type (for ex: PreallocBytes) is used directly in a request-response object.
// The codec defined in this package allows us to choose gogo marshalling/unmarshalling for specific structs (Tempo/Jaeger/Cortex) only.
package gogocodec
import (
"reflect"
"strings"
gogoproto "github.com/gogo/protobuf/proto"
"google.golang.org/grpc/encoding"
"google.golang.org/protobuf/proto"
)
const (
frontendProtoGenPkgPath = "github.com/grafana/tempo/modules/frontend"
tempoProtoGenPkgPath = "github.com/grafana/tempo/pkg/tempopb"
jaegerProtoGenPkgPath = "github.com/jaegertracing/jaeger-idl/proto-gen"
jaegerModelPkgPath = "github.com/jaegertracing/jaeger-idl/model"
jaegerStorageV1PkgPath = "github.com/grafana/tempo/cmd/tempo-query/jaeger/storage_v1"
otelProtoPkgPath = "go.opentelemetry.io/collector"
// etcd path can be removed once upgrade to grpc >v1.38 is released (tentatively next release from v3.5.1)
etcdAPIProtoPkgPath = "go.etcd.io/etcd/api/v3"
)
// GogoCodec forces the use of gogo proto marshalling/unmarshalling for Tempo/Cortex/Jaeger/etcd structs
type GogoCodec struct{}
var _ encoding.Codec = (*GogoCodec)(nil)
func NewCodec() *GogoCodec {
return &GogoCodec{}
}
// Name implements encoding.Codec
func (c *GogoCodec) Name() string {
return "proto"
}
// Marshal implements encoding.Codec
func (c *GogoCodec) Marshal(v interface{}) ([]byte, error) {
t := reflect.TypeOf(v)
elem := t.Elem()
// use gogo proto only for Tempo/Cortex/Jaeger/etcd types
if useGogo(elem) {
return gogoproto.Marshal(v.(gogoproto.Message))
}
return proto.Marshal(v.(proto.Message))
}
// Unmarshal implements encoding.Codec
func (c *GogoCodec) Unmarshal(data []byte, v interface{}) error {
t := reflect.TypeOf(v)
elem := t.Elem()
// use gogo proto only for Tempo/Cortex/Jaeger/etcd types
if useGogo(elem) {
return gogoproto.Unmarshal(data, v.(gogoproto.Message))
}
return proto.Unmarshal(data, v.(proto.Message))
}
// useGogo checks if the element belongs to Tempo/Cortex/Jaeger/etcd packages
func useGogo(t reflect.Type) bool {
if t == nil {
return false
}
pkgPath := t.PkgPath()
return strings.HasPrefix(pkgPath, frontendProtoGenPkgPath) || strings.HasPrefix(pkgPath, tempoProtoGenPkgPath) || strings.HasPrefix(pkgPath, jaegerProtoGenPkgPath) || strings.HasPrefix(pkgPath, jaegerModelPkgPath) || strings.HasPrefix(pkgPath, jaegerStorageV1PkgPath) || strings.HasPrefix(pkgPath, otelProtoPkgPath) || strings.HasPrefix(pkgPath, etcdAPIProtoPkgPath)
}