-
Notifications
You must be signed in to change notification settings - Fork 435
/
mockspan.go
277 lines (241 loc) · 6.59 KB
/
mockspan.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2016 Datadog, Inc.
package mocktracer // import "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/mocktracer"
import (
"fmt"
"sync"
"time"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/ext"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
)
var _ ddtrace.Span = (*mockspan)(nil)
var _ Span = (*mockspan)(nil)
// Span is an interface that allows querying a span returned by the mock tracer.
type Span interface {
// SpanID returns the span's ID.
SpanID() uint64
// TraceID returns the span's trace ID.
TraceID() uint64
// ParentID returns the span's parent ID.
ParentID() uint64
// StartTime returns the time when the span has started.
StartTime() time.Time
// FinishTime returns the time when the span has finished.
FinishTime() time.Time
// OperationName returns the operation name held by this span.
OperationName() string
// Tag returns the value of the tag at key k.
Tag(k string) interface{}
// Tags returns a copy of all the tags in this span.
Tags() map[string]interface{}
// Context returns the span's SpanContext.
Context() ddtrace.SpanContext
// Stringer allows pretty-printing the span's fields for debugging.
fmt.Stringer
}
func newSpan(t *mocktracer, operationName string, cfg *ddtrace.StartSpanConfig) *mockspan {
if cfg.Tags == nil {
cfg.Tags = make(map[string]interface{})
}
if cfg.Tags[ext.ResourceName] == nil {
cfg.Tags[ext.ResourceName] = operationName
}
s := &mockspan{
name: operationName,
tracer: t,
}
if cfg.StartTime.IsZero() {
s.startTime = time.Now()
} else {
s.startTime = cfg.StartTime
}
id := cfg.SpanID
if id == 0 {
id = nextID()
}
s.context = &spanContext{spanID: id, traceID: id, span: s}
if ctx, ok := cfg.Parent.(*spanContext); ok {
if ctx.span != nil && s.tags[ext.ServiceName] == nil {
// if we have a local parent and no service, inherit the parent's
s.SetTag(ext.ServiceName, ctx.span.Tag(ext.ServiceName))
}
if ctx.hasSamplingPriority() {
s.SetTag(ext.SamplingPriority, ctx.samplingPriority())
}
s.parentID = ctx.spanID
s.context.priority = ctx.samplingPriority()
s.context.hasPriority = ctx.hasSamplingPriority()
s.context.traceID = ctx.traceID
s.context.baggage = make(map[string]string, len(ctx.baggage))
ctx.ForeachBaggageItem(func(k, v string) bool {
s.context.baggage[k] = v
return true
})
}
for k, v := range cfg.Tags {
s.SetTag(k, v)
}
return s
}
type mockspan struct {
sync.RWMutex // guards below fields
name string
tags map[string]interface{}
finishTime time.Time
finished bool
startTime time.Time
parentID uint64
context *spanContext
tracer *mocktracer
}
// SetTag sets a given tag on the span.
func (s *mockspan) SetTag(key string, value interface{}) {
s.Lock()
defer s.Unlock()
if s.finished {
return
}
if s.tags == nil {
s.tags = make(map[string]interface{}, 1)
}
if key == ext.SamplingPriority {
switch p := value.(type) {
case int:
s.context.setSamplingPriority(p)
case float64:
s.context.setSamplingPriority(int(p))
}
}
s.tags[key] = value
}
func (s *mockspan) FinishTime() time.Time {
s.RLock()
defer s.RUnlock()
return s.finishTime
}
func (s *mockspan) StartTime() time.Time { return s.startTime }
func (s *mockspan) Tag(k string) interface{} {
s.RLock()
defer s.RUnlock()
return s.tags[k]
}
func (s *mockspan) Tags() map[string]interface{} {
s.RLock()
defer s.RUnlock()
// copy
cp := make(map[string]interface{}, len(s.tags))
for k, v := range s.tags {
cp[k] = v
}
return cp
}
func (s *mockspan) TraceID() uint64 { return s.context.traceID }
func (s *mockspan) SpanID() uint64 { return s.context.spanID }
func (s *mockspan) ParentID() uint64 { return s.parentID }
func (s *mockspan) OperationName() string {
s.RLock()
defer s.RUnlock()
return s.name
}
// SetOperationName resets the original operation name to the given one.
func (s *mockspan) SetOperationName(operationName string) {
s.Lock()
defer s.Unlock()
s.name = operationName
return
}
// BaggageItem returns the baggage item with the given key.
func (s *mockspan) BaggageItem(key string) string {
return s.context.baggageItem(key)
}
// SetBaggageItem sets a new baggage item at the given key. The baggage
// item should propagate to all descendant spans, both in- and cross-process.
func (s *mockspan) SetBaggageItem(key, val string) {
s.context.setBaggageItem(key, val)
return
}
// Finish finishes the current span with the given options.
func (s *mockspan) Finish(opts ...ddtrace.FinishOption) {
var cfg ddtrace.FinishConfig
for _, fn := range opts {
fn(&cfg)
}
var t time.Time
if cfg.FinishTime.IsZero() {
t = time.Now()
} else {
t = cfg.FinishTime
}
if cfg.Error != nil {
s.SetTag(ext.Error, cfg.Error)
}
if cfg.NoDebugStack {
s.SetTag(ext.ErrorStack, "<debug stack disabled>")
}
s.Lock()
defer s.Unlock()
if s.finished {
return
}
s.finished = true
s.finishTime = t
s.tracer.addFinishedSpan(s)
}
// String implements fmt.Stringer.
func (s *mockspan) String() string {
sc := s.context
return fmt.Sprintf(`
name: %s
tags: %#v
start: %s
finish: %s
id: %d
parent: %d
trace: %d
baggage: %#v
`, s.name, s.tags, s.startTime, s.finishTime, sc.spanID, s.parentID, sc.traceID, sc.baggage)
}
// Context returns the SpanContext of this Span.
func (s *mockspan) Context() ddtrace.SpanContext { return s.context }
// SetUser associates user information to the current trace which the
// provided span belongs to. The options can be used to tune which user
// bit of information gets monitored. This mockup only sets the user
// information as span tags of the root span of the current trace.
func (s *mockspan) SetUser(id string, opts ...tracer.UserMonitoringOption) {
root := s.Root()
if root == nil {
return
}
var cfg tracer.UserMonitoringConfig
for _, fn := range opts {
fn(&cfg)
}
root.SetTag("usr.id", id)
root.SetTag("usr.email", cfg.Email)
root.SetTag("usr.name", cfg.Name)
root.SetTag("usr.role", cfg.Role)
root.SetTag("usr.scope", cfg.Scope)
root.SetTag("usr.session_id", cfg.SessionID)
}
// Root walks the span up to the root parent span and returns it.
// This method is required by some internal packages such as appsec.
func (s *mockspan) Root() tracer.Span {
openSpans := s.tracer.openSpans
var current Span = s
for {
pid := current.ParentID()
if pid == 0 {
break
}
parent, ok := openSpans[pid]
if !ok {
break
}
current = parent
}
root, _ := current.(*mockspan)
return root
}