-
Notifications
You must be signed in to change notification settings - Fork 2
/
tel.go
211 lines (166 loc) · 4.84 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
package tel
import (
"context"
"fmt"
"math/rand"
"time"
"github.com/d7561985/tel/v2/monitoring/metrics"
"github.com/d7561985/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
mon Monitor // mon obsolete
meter metric.Meter
cfg *Config
}
func NewNull() Telemetry {
cfg := DefaultDebugConfig()
return Telemetry{
cfg: &cfg,
Logger: zap.NewExample(),
trace: trace.NewNoopTracerProvider().Tracer(instrumentationName),
meter: metric.NewNoopMeterProvider().Meter(instrumentationName),
mon: createNilMonitor(),
}
}
// New create full featured telemetry instance and register it as global
func New(ctx context.Context, cfg Config) (Telemetry, func()) {
// required as it use for generate uid
rand.Seed(time.Now().Unix())
res := CreateRes(ctx, cfg)
srvName := GenServiceName(cfg.Namespace, cfg.Service)
// init OTEL
logger, closer := newLogger(ctx, res, cfg)
closers := []func(context.Context){closer}
closers = append(closers,
newOtlpTrace(ctx, res, cfg),
newOtlpMetic(ctx, res, cfg),
)
out := Telemetry{
cfg: &cfg,
Logger: logger,
trace: otel.Tracer(srvName + "_tracer"),
mon: newMonitor(cfg),
meter: global.Meter(srvName+"_meter", metric.WithInstrumentationVersion("hello")),
}
SetGlobal(out)
return out, func() {
ccx, cancel := context.WithTimeout(context.Background(), time.Minute)
defer cancel()
for _, cb := range closers {
cb(ccx)
}
out.close()
}
}
// Close properly Telemetry instance
func (t *Telemetry) close() {
t.Info("Tel close begins")
if t.mon != nil {
t.mon.GracefulStop(t.Ctx())
}
if err := t.Logger.Sync(); err != nil {
t.Logger.Error("Telemetry logger sync at close", Error(err))
}
}
// 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 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
func (t Telemetry) Ctx() context.Context {
return WithContext(context.Background(), t)
}
// 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
}
// M returns monitoring instance
func (t Telemetry) M() Monitor {
return t.mon
}
func (t Telemetry) MM() metric.Meter {
return t.meter
}
// StartMonitor is blocking operation
func (t *Telemetry) StartMonitor() {
ctx := t.Ctx()
t.mon.AddMetricTracker(ctx, metrics.NewGrpcClientTracker())
t.mon.Start(ctx)
}
// 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
func (t *Telemetry) PutFields(fields ...zap.Field) *Telemetry {
t.Logger = t.Logger.With(fields...)
return t
}
// PutAttr opentelemetry attr
func (t *Telemetry) PutAttr(attr ...attribute.KeyValue) *Telemetry {
for _, value := range attr {
t.Logger = t.Logger.With(String(string(value.Key), value.Value.Emit()))
}
return t
}
// StartSpan start absolutely new trace telemetry span
// keep in mind than that function don't continue any trace, only create new
// for continue span use StartSpanFromContext
//
// return context where embed telemetry with span writer
func (t *Telemetry) StartSpan(name string, opts ...trace.SpanStartOption) (trace.Span, context.Context) {
cxt, s := t.trace.Start(context.Background(), name, opts...)
ccx := WithContext(cxt, *t.WithSpan(s))
UpdateTraceFields(ccx)
return s, ccx
}
// 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 {
return zapcore.NewTee(core, ztrace.New(s))
}))
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
}
func SetGlobal(t Telemetry) {
globalTelemetry = t
}
func defaultServiceFmt(ns, service string) string {
return fmt.Sprintf("%s_%s", ns, service)
}