-
Notifications
You must be signed in to change notification settings - Fork 4
/
tracer.go
483 lines (411 loc) · 10.8 KB
/
tracer.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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
package tracer
import (
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"strings"
"sync"
"time"
"github.com/asaskevich/govalidator"
"github.com/gin-gonic/gin"
"github.com/opentracing/opentracing-go"
"github.com/opentracing/opentracing-go/ext"
tracelog "github.com/opentracing/opentracing-go/log"
"github.com/pkg/errors"
"github.com/uber/jaeger-client-go"
jaegercfg "github.com/uber/jaeger-client-go/config"
jaegerlog "github.com/uber/jaeger-client-go/log"
"github.com/uber/jaeger-client-go/transport"
"github.com/uber/jaeger-lib/metrics"
)
const (
HeaderTraceID = "trace-id"
HeaderSpanID = "span-id"
HeaderXTraceID = "x-trace-id"
)
var (
gtracer opentracing.Tracer
closer io.Closer
mutex sync.Mutex
)
var (
// opentrace log
LogString = tracelog.String
LogInt = tracelog.Int
LogObject = tracelog.Object
)
const (
protoUdp = iota
protoHttp
)
// GetTracer
func GetTracer() opentracing.Tracer {
return gtracer
}
// SetTracer
func SeteTracer(otracer opentracing.Tracer) {
gtracer = otracer
opentracing.SetGlobalTracer(otracer)
}
// Close
func Close() error {
if closer != nil {
return nil
}
return closer.Close()
}
func NewHttpSender(url string) jaeger.Transport {
var (
client = &http.Client{}
trans = &http.Transport{
MaxIdleConnsPerHost: 50,
MaxIdleConns: 100,
}
)
client.Transport = trans
return transport.NewHTTPTransport(
url,
transport.HTTPBatchSize(100),
transport.HTTPTimeout(1*time.Second),
transport.HTTPRoundTripper(trans),
)
}
type Config struct {
ServiceName string `yaml:"service_name"`
Address string `yaml:"addr"`
QueueSize int `yaml:"queue_size"`
BufferFlushInterval int `yaml:"buffer_flush_interval"`
MaxTagLength int `yaml:"max_tag_length"`
ProtoKind int `yaml:"proto_kind"`
}
type Option struct {
samplerConfig *jaegercfg.SamplerConfig
reporterConfig *jaegercfg.ReporterConfig
sender jaeger.Transport
queueSize int
bufferFlushInterval int
maxTagLength int
protoKind int
}
func defaultOption() *Option {
return &Option{
queueSize: 10000, // size of buffer queue wait to send
maxTagLength: 256, // default value in jaeger client
bufferFlushInterval: 1, // unit: time ms
}
}
type optionFunc func(*Option) error
// WithSender
func WithSender(sender jaeger.Transport) optionFunc {
return func(o *Option) error {
o.sender = sender
return nil
}
}
// WithProtoKind
func WithProtoKind(kind int) optionFunc {
return func(o *Option) error {
o.protoKind = kind
return nil
}
}
// WithQueueSize queue size, defualt: 10000
func WithQueueSize(size int) optionFunc {
return func(o *Option) error {
def := 10000
if size <= 0 || size > def {
size = def
}
o.queueSize = size
return nil
}
}
// WithFlushInterval
func WithFlushInterval(ms int) optionFunc {
return func(o *Option) error {
var (
maxThold = 5000 // 5s
minThold = 200 // 200ms
)
if ms > maxThold {
ms = maxThold
}
if ms < minThold {
ms = minThold
}
o.bufferFlushInterval = ms
return nil
}
}
// WithMaxTagLength
func WithMaxTagLength(size int) optionFunc {
return func(o *Option) error {
def := 256
if size <= 0 || size > def {
size = def
}
o.maxTagLength = size
return nil
}
}
// WithSampler
func WithSampler(sampler *jaegercfg.SamplerConfig) optionFunc {
return func(o *Option) error {
o.samplerConfig = sampler
return nil
}
}
// WithReporter
func WithReporter(cfg *jaegercfg.ReporterConfig) optionFunc {
return func(o *Option) error {
o.reporterConfig = cfg
return nil
}
}
// NewTracerWithConfig
func NewTracerWithConfig(cfg *Config) (opentracing.Tracer, io.Closer, error) {
return NewTracer(
cfg.ServiceName,
cfg.Address,
WithFlushInterval(cfg.BufferFlushInterval),
WithMaxTagLength(cfg.MaxTagLength),
WithQueueSize(cfg.QueueSize),
WithProtoKind(cfg.ProtoKind),
)
}
// NewTracer
func NewTracer(serviceName string, addr string, fns ...optionFunc) (opentracing.Tracer, io.Closer, error) {
if serviceName == "" {
return nil, nil, errors.New("invalid service name")
}
if addr == "" {
return nil, nil, errors.New("invalid address")
}
option := defaultOption()
for _, fn := range fns {
err := fn(option)
if err != nil {
return nil, nil, err
}
}
if option.protoKind == protoUdp {
cols := strings.Split(addr, ":")
if len(cols) != 2 {
return nil, nil, errors.New("invalid addr")
}
if !govalidator.IsIP(cols[0]) || !govalidator.IsPort(cols[1]) {
return nil, nil, errors.New("invalid addr")
}
}
// default config
cfg := &jaegercfg.Configuration{
ServiceName: serviceName,
Sampler: option.samplerConfig, // doc: https://www.jaegertracing.io/docs/1.28/sampling/
Reporter: option.reporterConfig,
Headers: &jaeger.HeadersConfig{
JaegerDebugHeader: "x-debug-id",
JaegerBaggageHeader: "x-baggage",
TraceContextHeaderName: "x-trace-id",
TraceBaggageHeaderPrefix: "x-ctx-",
},
}
if option.samplerConfig == nil {
cfg.Sampler = &jaegercfg.SamplerConfig{
Type: jaeger.SamplerTypeConst,
Param: 1,
}
}
if option.reporterConfig != nil {
cfg.Reporter = &jaegercfg.ReporterConfig{
LogSpans: true,
QueueSize: option.queueSize,
DisableAttemptReconnecting: false,
BufferFlushInterval: time.Duration(option.bufferFlushInterval) * time.Millisecond,
}
}
sender, err := jaeger.NewUDPTransport(addr, 0)
if err != nil {
return nil, nil, err
}
if option.sender != nil {
sender = option.sender
}
reporter := jaeger.NewRemoteReporter(sender)
logger := jaegerlog.StdLogger
jmetrics := metrics.NullFactory
// init tracer with a logger and a metrics factory
gtracer, closer, err = cfg.NewTracer(
jaegercfg.Reporter(reporter),
jaegercfg.Logger(logger),
jaegercfg.Metrics(jmetrics),
jaegercfg.MaxTagValueLength(option.maxTagLength),
)
opentracing.SetGlobalTracer(gtracer)
return gtracer, closer, err
}
// ContextWithSpan returns a new `context.Context` that holds a reference to
// the span. If span is nil, a new context without an active span is returned.
func ContextWithSpan(ctx context.Context, span opentracing.Span) context.Context {
return opentracing.ContextWithSpan(ctx, span)
}
// StartSpan Create, start, and return a new Span with the given `operationName`.
func StartSpan(operation string, opts ...opentracing.StartSpanOption) opentracing.Span {
return gtracer.StartSpan(operation, opts...)
}
// StartSpanContext
func StartSpanContext(operation string, opts ...opentracing.StartSpanOption) (context.Context, opentracing.Span) {
span := gtracer.StartSpan(operation, opts...)
ctx := ContextWithSpan(context.Background(), span)
return ctx, span
}
// StartSpanFromContext starts and returns a Span with `operationName`, using
// any Span found within `ctx` as a ChildOfRef.
func StartSpanFromContext(ctx context.Context, operation string) (opentracing.Span, context.Context) {
return opentracing.StartSpanFromContext(ctx, operation)
}
// SpanFromContextExt
func StartSpanFromContextExt(ctx context.Context, fname string, request, response interface{}) (opentracing.Span, context.Context, func()) {
span, cctx := opentracing.StartSpanFromContext(ctx, fname)
defered := func() {
if request != nil {
span.SetTag("request", request)
}
if response != nil {
span.SetTag("response", response)
}
span.Finish()
}
return span, cctx, defered
}
func StartSpanFromGinContext(ctx *gin.Context, fname string, request, response interface{}) (opentracing.Span, context.Context, func()) {
return StartSpanFromContextExt(ctx.Request.Context(), fname, request, response)
}
// SpanFromContext
func SpanFromContext(ctx context.Context) opentracing.Span {
return opentracing.SpanFromContext(ctx)
}
// GetTraceID get trace id from span
func GetTraceID(span opentracing.Span) string {
sc, ok := span.Context().(jaeger.SpanContext)
if ok {
return sc.TraceID().String()
}
return ""
}
type SpanEntry struct {
jaegerSpanCtx jaeger.SpanContext
TraceID string
SpanID string
ParentSpanID string
Flags string
}
func (se *SpanEntry) String() string {
return se.jaegerSpanCtx.String()
}
func (se *SpanEntry) IsNull() bool {
if se.TraceID == "" {
return true
}
return false
}
// GetSpanEntryFromCtx
func GetSpanEntryFromCtx(ctx context.Context) SpanEntry {
span := opentracing.SpanFromContext(ctx)
if span == nil {
return SpanEntry{}
}
sc, ok := span.Context().(jaeger.SpanContext)
if ok {
se := SpanEntry{
jaegerSpanCtx: sc,
TraceID: sc.TraceID().String(),
SpanID: sc.SpanID().String(),
ParentSpanID: sc.ParentID().String(),
Flags: string(sc.Flags()),
}
return se
}
return SpanEntry{}
}
// GetTraceIDFromCtx get trace id from context
func GetTraceIDFromCtx(ctx context.Context) string {
span := opentracing.SpanFromContext(ctx)
return GetTraceID(span)
}
// GetSpanIDFromCtx get span id from context
func GetSpanIDFromCtx(ctx context.Context) string {
span := opentracing.SpanFromContext(ctx)
return GetSpanID(span)
}
func GetTraceSpanIDsFromCtx(ctx context.Context) (string, string) {
span := opentracing.SpanFromContext(ctx)
return GetTraceSpanIDs(span)
}
// GetSpanID get span id
func GetSpanID(span opentracing.Span) string {
sc, ok := span.Context().(jaeger.SpanContext)
if ok {
return sc.SpanID().String()
}
return ""
}
// GetTraceSpanIDs
func GetTraceSpanIDs(span opentracing.Span) (string, string) {
sc, ok := span.Context().(jaeger.SpanContext)
if ok {
return sc.TraceID().String(), sc.SpanID().String()
}
return "", ""
}
// GetParentID get parent span id
func GetParentID(span opentracing.Span) string {
sc, ok := span.Context().(jaeger.SpanContext)
if ok {
return sc.ParentID().String()
}
return ""
}
// GetFullTraceID
func GetFullTraceID(span opentracing.Span) string {
return GetXTraceID(span)
}
// GetXTraceID get x-trace-id by span
func GetXTraceID(span opentracing.Span) string {
sc, ok := span.Context().(jaeger.SpanContext)
if ok {
// hex16(traceid):hex16(spanid):hex16(parentid):hex16(flag)
return sc.String()
}
return ""
}
// MakeFullTraceID return x-trace-id
func MakeFullTraceID() string {
span, _ := opentracing.StartSpanFromContext(context.Background(), "")
return GetFullTraceID(span)
}
// ContextFromString build context by x-trace-id
func ContextFromString(xid string) (jaeger.SpanContext, error) {
ctx, err := jaeger.ContextFromString(xid)
return ctx, err
}
// ContextFromString build span by x-trace-id
func SpanFromString(operation, xid string) (opentracing.Span, error) {
ctx, err := ContextFromString(xid)
if err != nil {
return nil, err
}
span := opentracing.StartSpan(
operation,
ext.RPCServerOption(ctx),
)
return span, err
}
func marshal(in interface{}) string {
bs, err := json.Marshal(in)
if err != nil {
return fmt.Sprintf("%v", in)
}
return string(bs)
}