-
Notifications
You must be signed in to change notification settings - Fork 3
/
tel.go
283 lines (223 loc) · 6.86 KB
/
tel.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
package tel
import (
"context"
"fmt"
"math/rand"
"time"
"github.com/tel-io/tel/v2/pkg/ztrace"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/metric"
"go.opentelemetry.io/otel/metric/global"
"go.opentelemetry.io/otel/trace"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
var (
globalTelemetry = NewNull()
GenServiceName = defaultServiceFmt
)
type Telemetry struct {
*zap.Logger
trace trace.Tracer
// current span
span trace.Span
cfg *Config
traceProvider trace.TracerProvider
metricProvider metric.MeterProvider
}
func NewNull() Telemetry {
cfg := DefaultDebugConfig()
return Telemetry{
cfg: &cfg,
Logger: zap.NewExample(),
trace: trace.NewNoopTracerProvider().Tracer(instrumentationName),
traceProvider: trace.NewNoopTracerProvider(),
metricProvider: metric.NewNoopMeterProvider(),
}
}
// NewSimple create simple logger without OTEL propagation
func NewSimple(cfg Config) Telemetry {
// required as it use for generate uid
rand.Seed(time.Now().Unix())
traceProvider := trace.NewNoopTracerProvider()
out := Telemetry{
cfg: &cfg,
Logger: newLogger(cfg),
trace: traceProvider.Tracer(instrumentationName),
traceProvider: traceProvider,
metricProvider: metric.NewNoopMeterProvider(),
}
zap.ReplaceGlobals(out.Logger)
otel.SetTracerProvider(out.traceProvider)
global.SetMeterProvider(out.metricProvider)
SetGlobal(out)
return out
}
// New create telemetry instance
func New(ctx context.Context, cfg Config, options ...Option) (Telemetry, func()) {
for _, option := range options {
option.apply(&cfg)
}
out := NewSimple(cfg)
var controls []controllers
if cfg.OtelConfig.Enable {
res := CreateRes(ctx, cfg)
// we're afraid that someone double this or miss something - that's why none exported options
controls = append(controls, withOtelLog(res), withOtelTrace(res), withOtelMetric(res))
if cfg.Logs.OtelClient {
controls = append(controls, withOtelClientLog())
}
if cfg.Logs.OtelProcessor {
controls = append(controls, withOtelProcessor())
}
}
if cfg.MonitorConfig.Enable {
controls = append(controls, withMonitor())
}
var closers []func(context.Context)
for _, fn := range controls {
closers = append(closers, fn.apply(ctx, &out))
}
SetGlobal(out)
return out, func() {
ccx, cancel := context.WithTimeout(context.Background(), time.Minute)
defer cancel()
for _, cb := range closers {
cb(ccx)
}
}
}
// IsDebug if ENV DEBUG was true
func (t Telemetry) IsDebug() bool {
return t.cfg.Debug
}
// LogLevel safe pars log level, in case of error return InfoLevel
func (t Telemetry) LogLevel() zapcore.Level {
if t.cfg == nil {
return zapcore.InfoLevel
}
var lvl zapcore.Level
if err := lvl.Set(t.cfg.LogLevel); err != nil {
return zapcore.InfoLevel
}
return lvl
}
// WithContext put new copy of telemetry into context
func (t Telemetry) WithContext(ctx context.Context) context.Context {
return WithContext(ctx, t)
}
// Ctx initiate new ctx with Telemetry and span instance if occured
func (t Telemetry) Ctx() context.Context {
ctx := WithContext(context.Background(), t)
if t.Span() != nil {
return trace.ContextWithSpan(ctx, t.Span())
}
return ctx
}
// Copy resiver instance and give us more convenient way to use pipelines
func (t Telemetry) Copy() Telemetry {
return t
}
// T returns opentracing instance
func (t Telemetry) T() trace.Tracer {
return t.trace
}
// Span last created span
func (t Telemetry) Span() trace.Span {
return t.span
}
// PutSpan ...
// WARN: NON THREAD SAFE
// Be careful using this method with tel.Global()
func (t *Telemetry) PutSpan(in trace.Span) {
t.span = in
}
// MetricProvider used in constructor creation
func (t Telemetry) MetricProvider() metric.MeterProvider {
return t.metricProvider
}
// Meter create new metric instance which should be treated as new
func (t Telemetry) Meter(ins string, opts ...metric.MeterOption) metric.Meter {
return t.metricProvider.Meter(ins, opts...)
}
// TracerProvider used in constructor creation
func (t Telemetry) TracerProvider() trace.TracerProvider {
return t.traceProvider
}
// Tracer instantiate with specific name and tel option
// @return new Telemetry pointed to this one
func (t Telemetry) Tracer(name string, opts ...trace.TracerOption) Telemetry {
t.trace = t.traceProvider.Tracer(name, opts...)
return t
}
// PutFields update current logger instance with new fields,
// which would affect only on nest write log call for current tele instance
// Because reference it also affect context and this approach is covered in Test_telemetry_With
// WARN: NON THREAD SAFE
// Be careful using this method with tel.Global()
func (t *Telemetry) PutFields(fields ...zap.Field) *Telemetry {
t.Logger = t.Logger.With(fields...)
return t
}
// PutAttr opentelemetry attr
// WARN: NON THREAD SAFE
// Be careful using this method with tel.Global()
func (t *Telemetry) PutAttr(attr ...attribute.KeyValue) *Telemetry {
var fields []zap.Field
for _, kv := range attr {
fields = append(fields, String(string(kv.Key), kv.Value.Emit()))
}
t.PutFields(fields...)
return t
}
// StartSpan start new trace telemetry span
// in case if ctx contains embed trace it will continue chain
// keep in mind than that function don't continue any trace, only create new
// for continue span use StartSpanFromContext
// In addition: register new root span in new ctx instance
//
// return context where embed telemetry with span writer
func (t *Telemetry) StartSpan(ctx context.Context, name string, opts ...trace.SpanStartOption) (trace.Span, context.Context) {
// In case current instance contains active span
// we would like to continue it
if !trace.SpanContextFromContext(ctx).IsValid() && t.Span() != nil && t.Span().IsRecording() {
ctx = trace.ContextWithSpan(ctx, t.Span())
}
ctx, span := t.trace.Start(ctx, name, opts...)
tele := t.WithSpan(span)
tele.PutSpan(span)
ctx = WrapContext(ctx, tele)
UpdateTraceFields(ctx)
return span, ctx
}
// WithSpan create span logger where we can duplicate messages both tracer and logger
// Furthermore we create new log instance with trace fields
func (t Telemetry) WithSpan(s trace.Span) *Telemetry {
t.Logger = t.Logger.WithOptions(
zap.WrapCore(func(core zapcore.Core) zapcore.Core {
traceCore := ztrace.New(
t.LogLevel(),
s,
ztrace.WithTrackLogFields(t.cfg.Traces.EnableSpanTrackLogFields),
ztrace.WithTrackLogMessage(t.cfg.Traces.EnableSpanTrackLogMessage),
)
return zapcore.NewTee(core, traceCore)
}),
)
return &t
}
// Printf expose fx.Printer interface as debug output
func (t *Telemetry) Printf(msg string, items ...interface{}) {
t.Debug(fmt.Sprintf(msg, items...))
}
func Global() Telemetry {
return globalTelemetry
}
// WARN: NON THREAD SAFE
func SetGlobal(t Telemetry) {
globalTelemetry = t
}
func defaultServiceFmt(ns, service string) string {
return fmt.Sprintf("%s_%s", ns, service)
}