Redefine model/ and api_v2/ types as aliases to jaeger-idl/ types

go.mod

@@ -161,6 +161,7 @@ require (
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/iancoleman/strcase v0.3.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/jaegertracing/jaeger-idl v0.0.0-20250122172554-3e525d710892
 	github.com/jcmturner/aescts/v2 v2.0.0 // indirect
 	github.com/jcmturner/dnsutils/v2 v2.0.0 // indirect
 	github.com/jcmturner/gofork v1.7.6 // indirect

go.sum

@@ -329,6 +329,8 @@ github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
 github.com/ionos-cloud/sdk-go/v6 v6.1.11 h1:J/uRN4UWO3wCyGOeDdMKv8LWRzKu6UIkLEaes38Kzh8=
 github.com/ionos-cloud/sdk-go/v6 v6.1.11/go.mod h1:EzEgRIDxBELvfoa/uBN0kOQaqovLjUWEB7iW4/Q+t4k=
+github.com/jaegertracing/jaeger-idl v0.0.0-20250122172554-3e525d710892 h1:wDzNPLnnHOGCvGpLGn78gPo6Cqxpdil5TkS9dKfT2cE=
+github.com/jaegertracing/jaeger-idl v0.0.0-20250122172554-3e525d710892/go.mod h1:TimiEKGlMAcMZsKSHJkXNo0I0Q39iaENPswLXA1I2XY=
 github.com/jcmturner/aescts/v2 v2.0.0 h1:9YKLH6ey7H4eDBXW8khjYslgyqG2xZikXP0EQFKrle8=
 github.com/jcmturner/aescts/v2 v2.0.0/go.mod h1:AiaICIRyfYg35RUkr8yESTqvSy7csK90qZ5xfvvsoNs=
 github.com/jcmturner/dnsutils/v2 v2.0.0 h1:lltnkeZGL0wILNvrNiVCR6Ro5PGU/SeBvVO/8c/iPbo=

model/dependencies.go

@@ -8,12 +8,3 @@ const (
 	// JaegerDependencyLinkSource describes a dependency diagram that was generated from Jaeger traces.
 	JaegerDependencyLinkSource = "jaeger"
 )
-
-// ApplyDefaults applies defaults to the DependencyLink.
-func (d DependencyLink) ApplyDefaults() DependencyLink {
-	dd := d
-	if dd.Source == "" {
-		dd.Source = JaegerDependencyLinkSource
-	}
-	return dd
-}

model/flags.go

@@ -4,56 +4,18 @@
 
 package model
 
+import (
+	jaegerIdlModel "github.com/jaegertracing/jaeger-idl/model/v1"
+)
+
 const (
 	// SampledFlag is the bit set in Flags in order to define a span as a sampled span
-	SampledFlag = Flags(1)
+	SampledFlag = jaegerIdlModel.SampledFlag
 	// DebugFlag is the bit set in Flags in order to define a span as a debug span
-	DebugFlag = Flags(2)
+	DebugFlag = jaegerIdlModel.SampledFlag
 	// FirehoseFlag is the bit in Flags in order to define a span as a firehose span
-	FirehoseFlag = Flags(8)
+	FirehoseFlag = jaegerIdlModel.SampledFlag
 )
 
 // Flags is a bit map of flags for a span
-type Flags uint32
-
-// ------- Flags -------
-
-// SetSampled sets the Flags as sampled
-func (f *Flags) SetSampled() {
-	f.setFlags(SampledFlag)
-}
-
-// SetDebug set the Flags as sampled
-func (f *Flags) SetDebug() {
-	f.setFlags(DebugFlag)
-}
-
-// SetFirehose set the Flags as firehose enabled
-func (f *Flags) SetFirehose() {
-	f.setFlags(FirehoseFlag)
-}
-
-func (f *Flags) setFlags(bit Flags) {
-	*f |= bit
-}
-
-// IsSampled returns true if the Flags denote sampling
-func (f Flags) IsSampled() bool {
-	return f.checkFlags(SampledFlag)
-}
-
-// IsDebug returns true if the Flags denote debugging
-// Debugging can be useful in testing tracing availability or correctness
-func (f Flags) IsDebug() bool {
-	return f.checkFlags(DebugFlag)
-}
-
-// IsFirehoseEnabled returns true if firehose is enabled
-// Firehose is used to decide whether to index a span or not
-func (f Flags) IsFirehoseEnabled() bool {
-	return f.checkFlags(FirehoseFlag)
-}
-
-func (f Flags) checkFlags(bit Flags) bool {
-	return f&bit == bit
-}
+type Flags = jaegerIdlModel.Flags

model/hash.go

@@ -5,21 +5,14 @@
 package model
 
 import (
-	"hash/fnv"
-	"io"
+	jaegerIdlModel "github.com/jaegertracing/jaeger-idl/model/v1"
 )
 
 // Hashable interface is for type that can participate in a hash computation
 // by writing their data into io.Writer, which is usually an instance of hash.Hash.
-type Hashable interface {
-	Hash(w io.Writer) error
-}
+type Hashable = jaegerIdlModel.Hashable
 
 // HashCode calculates a FNV-1a hash code for a Hashable object.
 func HashCode(o Hashable) (uint64, error) {
-	h := fnv.New64a()
-	if err := o.Hash(h); err != nil {
-		return 0, err
-	}
-	return h.Sum64(), nil
+	return jaegerIdlModel.HashCode(o)
 }

model/ids.go

@@ -5,241 +5,50 @@
 package model
 
 import (
-	"encoding/base64"
-	"encoding/binary"
-	"errors"
-	"fmt"
-	"strconv"
-
-	"github.com/gogo/protobuf/jsonpb"
+	jaegerIdlModel "github.com/jaegertracing/jaeger-idl/model/v1"
 )
 
 const (
 	// traceIDShortBytesLen indicates length of 64bit traceID when represented as list of bytes
 	traceIDShortBytesLen = 8
-	// traceIDLongBytesLen indicates length of 128bit traceID when represented as list of bytes
-	traceIDLongBytesLen = 16
 )
 
 // TraceID is a random 128bit identifier for a trace
-type TraceID struct {
-	Low  uint64 `json:"lo"`
-	High uint64 `json:"hi"`
-}
+type TraceID = jaegerIdlModel.TraceID
 
 // SpanID is a random 64bit identifier for a span
-type SpanID uint64
+type SpanID = jaegerIdlModel.SpanID
 
 // ------- TraceID -------
 
 // NewTraceID creates a new TraceID from two 64bit unsigned ints.
 func NewTraceID(high, low uint64) TraceID {
-	return TraceID{High: high, Low: low}
-}
-
-func (t TraceID) String() string {
-	if t.High == 0 {
-		return fmt.Sprintf("%016x", t.Low)
-	}
-	return fmt.Sprintf("%016x%016x", t.High, t.Low)
+	return jaegerIdlModel.NewTraceID(high, low)
 }
 
 // TraceIDFromString creates a TraceID from a hexadecimal string
 func TraceIDFromString(s string) (TraceID, error) {
-	var hi, lo uint64
-	var err error
-	switch {
-	case len(s) > 32:
-		return TraceID{}, fmt.Errorf("TraceID cannot be longer than 32 hex characters: %s", s)
-	case len(s) > 16:
-		hiLen := len(s) - 16
-		if hi, err = strconv.ParseUint(s[0:hiLen], 16, 64); err != nil {
-			return TraceID{}, err
-		}
-		if lo, err = strconv.ParseUint(s[hiLen:], 16, 64); err != nil {
-			return TraceID{}, err
-		}
-	default:
-		if lo, err = strconv.ParseUint(s, 16, 64); err != nil {
-			return TraceID{}, err
-		}
-	}
-	return TraceID{High: hi, Low: lo}, nil
+	return jaegerIdlModel.TraceIDFromString(s)
 }
 
 // TraceIDFromBytes creates a TraceID from list of bytes
 func TraceIDFromBytes(data []byte) (TraceID, error) {
-	var t TraceID
-	switch {
-	case len(data) == traceIDLongBytesLen:
-		t.High = binary.BigEndian.Uint64(data[:traceIDShortBytesLen])
-		t.Low = binary.BigEndian.Uint64(data[traceIDShortBytesLen:])
-	case len(data) == traceIDShortBytesLen:
-		t.Low = binary.BigEndian.Uint64(data)
-	default:
-		return TraceID{}, errors.New("invalid length for TraceID")
-	}
-	return t, nil
-}
-
-// MarshalText is called by encoding/json, which we do not want people to use.
-func (TraceID) MarshalText() ([]byte, error) {
-	return nil, errors.New("unsupported method TraceID.MarshalText; please use github.com/gogo/protobuf/jsonpb for marshalling")
-}
-
-// UnmarshalText is called by encoding/json, which we do not want people to use.
-func (*TraceID) UnmarshalText([]byte /* text */) error {
-	return errors.New("unsupported method TraceID.UnmarshalText; please use github.com/gogo/protobuf/jsonpb for marshalling")
-}
-
-// Size returns the size of this datum in protobuf. It is always 16 bytes.
-func (*TraceID) Size() int {
-	return 16
-}
-
-// MarshalTo converts trace ID into a binary representation. Called by protobuf serialization.
-func (t *TraceID) MarshalTo(data []byte) (n int, err error) {
-	var b [16]byte
-	binary.BigEndian.PutUint64(b[:8], uint64(t.High))
-	binary.BigEndian.PutUint64(b[8:], uint64(t.Low))
-	return marshalBytes(data, b[:])
-}
-
-// Unmarshal inflates this trace ID from binary representation. Called by protobuf serialization.
-func (t *TraceID) Unmarshal(data []byte) error {
-	var err error
-	*t, err = TraceIDFromBytes(data)
-	return err
-}
-
-func marshalBytes(dst []byte, src []byte) (n int, err error) {
-	if len(dst) < len(src) {
-		return 0, errors.New("buffer is too short")
-	}
-	return copy(dst, src), nil
-}
-
-// MarshalJSON converts trace id into a base64 string enclosed in quotes.
-// Used by protobuf JSON serialization.
-// Example: {high:2, low:1} => "AAAAAAAAAAIAAAAAAAAAAQ==".
-func (t TraceID) MarshalJSON() ([]byte, error) {
-	var b [16]byte
-	t.MarshalTo(b[:]) // can only error on incorrect buffer size
-	s := make([]byte, 24+2)
-	base64.StdEncoding.Encode(s[1:25], b[:])
-	s[0], s[25] = '"', '"'
-	return s, nil
-}
-
-// UnmarshalJSON inflates trace id from base64 string, possibly enclosed in quotes.
-// Used by protobuf JSON serialization.
-func (t *TraceID) UnmarshalJSON(data []byte) error {
-	s := string(data)
-	if l := len(s); l > 2 && s[0] == '"' && s[l-1] == '"' {
-		s = s[1 : l-1]
-	}
-	b, err := base64.StdEncoding.DecodeString(s)
-	if err != nil {
-		return fmt.Errorf("cannot unmarshal TraceID from string '%s': %w", string(data), err)
-	}
-	return t.Unmarshal(b)
+	return jaegerIdlModel.TraceIDFromBytes(data)
 }
 
 // ------- SpanID -------
 
 // NewSpanID creates a new SpanID from a 64bit unsigned int.
 func NewSpanID(v uint64) SpanID {
-	return SpanID(v)
-}
-
-func (s SpanID) String() string {
-	return fmt.Sprintf("%016x", uint64(s))
+	return jaegerIdlModel.NewSpanID(v)
 }
 
 // SpanIDFromString creates a SpanID from a hexadecimal string
 func SpanIDFromString(s string) (SpanID, error) {
-	if len(s) > 16 {
-		return SpanID(0), fmt.Errorf("SpanID cannot be longer than 16 hex characters: %s", s)
-	}
-	id, err := strconv.ParseUint(s, 16, 64)
-	if err != nil {
-		return SpanID(0), err
-	}
-	return SpanID(id), nil
+	return jaegerIdlModel.SpanIDFromString(s)
 }
 
 // SpanIDFromBytes creates a SpandID from list of bytes
 func SpanIDFromBytes(data []byte) (SpanID, error) {
-	if len(data) != traceIDShortBytesLen {
-		return SpanID(0), errors.New("invalid length for SpanID")
-	}
-	return NewSpanID(binary.BigEndian.Uint64(data)), nil
-}
-
-// MarshalText is called by encoding/json, which we do not want people to use.
-func (SpanID) MarshalText() ([]byte, error) {
-	return nil, errors.New("unsupported method SpanID.MarshalText; please use github.com/gogo/protobuf/jsonpb for marshalling")
-}
-
-// UnmarshalText is called by encoding/json, which we do not want people to use.
-func (*SpanID) UnmarshalText([]byte /* text */) error {
-	return errors.New("unsupported method SpanID.UnmarshalText; please use github.com/gogo/protobuf/jsonpb for marshalling")
-}
-
-// Size returns the size of this datum in protobuf. It is always 8 bytes.
-func (*SpanID) Size() int {
-	return 8
-}
-
-// MarshalTo converts span ID into a binary representation. Called by protobuf serialization.
-func (s *SpanID) MarshalTo(data []byte) (n int, err error) {
-	var b [8]byte
-	binary.BigEndian.PutUint64(b[:], uint64(*s))
-	return marshalBytes(data, b[:])
-}
-
-// Unmarshal inflates span ID from a binary representation. Called by protobuf serialization.
-func (s *SpanID) Unmarshal(data []byte) error {
-	var err error
-	*s, err = SpanIDFromBytes(data)
-	return err
-}
-
-// MarshalJSON converts span id into a base64 string enclosed in quotes.
-// Used by protobuf JSON serialization.
-// Example: {1} => "AAAAAAAAAAE=".
-func (s SpanID) MarshalJSON() ([]byte, error) {
-	var b [8]byte
-	s.MarshalTo(b[:]) // can only error on incorrect buffer size
-	v := make([]byte, 12+2)
-	base64.StdEncoding.Encode(v[1:13], b[:])
-	v[0], v[13] = '"', '"'
-	return v, nil
-}
-
-// UnmarshalJSON inflates span id from base64 string, possibly enclosed in quotes.
-// User by protobuf JSON serialization.
-//
-// There appears to be a bug in gogoproto, as this function is only called for numeric values.
-// https://github.com/gogo/protobuf/issues/411#issuecomment-393856837
-func (s *SpanID) UnmarshalJSON(data []byte) error {
-	str := string(data)
-	if l := len(str); l > 2 && str[0] == '"' && str[l-1] == '"' {
-		str = str[1 : l-1]
-	}
-	b, err := base64.StdEncoding.DecodeString(str)
-	if err != nil {
-		return fmt.Errorf("cannot unmarshal SpanID from string '%s': %w", string(data), err)
-	}
-	return s.Unmarshal(b)
-}
-
-// UnmarshalJSONPB inflates span id from base64 string, possibly enclosed in quotes.
-// User by protobuf JSON serialization.
-//
-// TODO: can be removed once this ticket is fixed:
-//
-// https://github.com/gogo/protobuf/issues/411#issuecomment-393856837
-func (s *SpanID) UnmarshalJSONPB(_ *jsonpb.Unmarshaler, b []byte) error {
-	return s.UnmarshalJSON(b)
+	return jaegerIdlModel.SpanIDFromBytes(data)
 }