Debian Codegraph @

sdk/trace/id_generator.go

raw
1 // Copyright The OpenTelemetry Authors
2 // SPDX-License-Identifier: Apache-2.0
3
4 package trace // import "go.opentelemetry.io/otel/sdk/trace"
5
6 import (
7 "context"
8 "encoding/binary"
9 "math/rand/v2"
10
11 "go.opentelemetry.io/otel/trace"
12 )
13
14 // IDGenerator allows custom generators for TraceID and SpanID.
15 type IDGenerator interface {
16 // DO NOT CHANGE: any modification will not be backwards compatible and
17 // must never be done outside of a new major release.
18
19 // NewIDs returns a new trace and span ID.
20 NewIDs(ctx context.Context) (trace.TraceID, trace.SpanID)
21 // DO NOT CHANGE: any modification will not be backwards compatible and
22 // must never be done outside of a new major release.
23
24 // NewSpanID returns a ID for a new span in the trace with traceID.
25 NewSpanID(ctx context.Context, traceID trace.TraceID) trace.SpanID
26 // DO NOT CHANGE: any modification will not be backwards compatible and
27 // must never be done outside of a new major release.
28 }
29
30 type randomIDGenerator struct{}
31
32 var _ IDGenerator = &randomIDGenerator{}
33
34 // NewSpanID returns a non-zero span ID from a randomly-chosen sequence.
35 func (*randomIDGenerator) NewSpanID(context.Context, trace.TraceID) trace.SpanID {
36 sid := trace.SpanID{}
37 for {
38 binary.NativeEndian.PutUint64(sid[:], rand.Uint64())
39 if sid.IsValid() {
40 break
41 }
42 }
43 return sid
44 }
45
46 // NewIDs returns a non-zero trace ID and a non-zero span ID from a
47 // randomly-chosen sequence.
48 func (*randomIDGenerator) NewIDs(context.Context) (trace.TraceID, trace.SpanID) {
49 tid := trace.TraceID{}
50 sid := trace.SpanID{}
51 for {
52 binary.NativeEndian.PutUint64(tid[:8], rand.Uint64())
53 binary.NativeEndian.PutUint64(tid[8:], rand.Uint64())
54 if tid.IsValid() {
55 break
56 }
57 }
58 for {
59 binary.NativeEndian.PutUint64(sid[:], rand.Uint64())
60 if sid.IsValid() {
61 break
62 }
63 }
64 return tid, sid
65 }
66
67 func defaultIDGenerator() IDGenerator {
68 return &randomIDGenerator{}
69 }