/
otel.go
453 lines (398 loc) · 13.3 KB
/
otel.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
package stats
import (
"context"
"errors"
"fmt"
"net/http"
"runtime"
"strings"
"sync"
"time"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/spf13/cast"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/metric"
noopMetric "go.opentelemetry.io/otel/metric/noop"
"go.opentelemetry.io/otel/propagation"
semconv "go.opentelemetry.io/otel/semconv/v1.24.0"
"go.opentelemetry.io/otel/trace"
"github.com/rudderlabs/rudder-go-kit/logger"
"github.com/rudderlabs/rudder-go-kit/stats/internal/otel"
)
const (
defaultMeterName = ""
)
// otelStats is an OTel-specific adapter that follows the Stats contract
type otelStats struct {
config statsConfig
otelConfig otelStatsConfig
resourceAttrs map[string]struct{}
tracerProvider trace.TracerProvider
traceBaseAttributes []attribute.KeyValue
tracerMap map[string]Tracer
tracerMapMu sync.Mutex
meter metric.Meter
noopMeter metric.Meter
counters map[string]metric.Int64Counter
countersMu sync.Mutex
gauges map[string]*otelGauge
gaugesMu sync.Mutex
timers map[string]metric.Float64Histogram
timersMu sync.Mutex
histograms map[string]metric.Float64Histogram
histogramsMu sync.Mutex
otelManager otel.Manager
runtimeStatsCollector runtimeStatsCollector
metricsStatsCollector metricStatsCollector
stopBackgroundCollection func()
logger logger.Logger
httpServer *http.Server
httpServerShutdownComplete chan struct{}
prometheusRegisterer prometheus.Registerer
prometheusGatherer prometheus.Gatherer
}
func (s *otelStats) Start(ctx context.Context, goFactory GoRoutineFactory) error {
if !s.config.enabled.Load() {
return nil
}
// Starting OpenTelemetry setup
var attrs []attribute.KeyValue
s.resourceAttrs = make(map[string]struct{})
if s.config.instanceName != "" {
sanitized := sanitizeTagKey("instanceName")
attrs = append(attrs, attribute.String(sanitized, s.config.instanceName))
s.resourceAttrs[sanitized] = struct{}{}
}
if s.config.namespaceIdentifier != "" {
sanitized := sanitizeTagKey("namespace")
attrs = append(attrs, attribute.String(sanitized, s.config.namespaceIdentifier))
s.resourceAttrs[sanitized] = struct{}{}
}
res, err := otel.NewResource(s.config.serviceName, s.config.serviceVersion, attrs...)
if err != nil {
return fmt.Errorf("failed to create open telemetry resource: %w", err)
}
options := []otel.Option{otel.WithInsecure(), otel.WithLogger(s.logger)}
if s.otelConfig.tracesEndpoint != "" {
s.traceBaseAttributes = attrs
tpOpts := []otel.TracerProviderOption{
otel.WithTracingSamplingRate(s.otelConfig.tracingSamplingRate),
}
if s.otelConfig.withTracingSyncer {
tpOpts = append(tpOpts, otel.WithTracingSyncer())
}
if s.otelConfig.withZipkin {
tpOpts = append(tpOpts, otel.WithZipkin())
}
options = append(options,
otel.WithTracerProvider(s.otelConfig.tracesEndpoint, tpOpts...),
otel.WithTextMapPropagator(
propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{}),
),
)
}
meterProviderOptions := []otel.MeterProviderOption{
otel.WithMeterProviderExportsInterval(s.otelConfig.metricsExportInterval),
}
if len(s.config.defaultHistogramBuckets) > 0 {
meterProviderOptions = append(meterProviderOptions,
otel.WithDefaultHistogramBucketBoundaries(s.config.defaultHistogramBuckets),
)
}
if len(s.config.histogramBuckets) > 0 {
for histogramName, buckets := range s.config.histogramBuckets {
meterProviderOptions = append(meterProviderOptions,
otel.WithHistogramBucketBoundaries(histogramName, defaultMeterName, buckets),
)
}
}
if s.otelConfig.metricsEndpoint != "" {
options = append(options, otel.WithMeterProvider(append(meterProviderOptions,
otel.WithGRPCMeterProvider(s.otelConfig.metricsEndpoint),
)...))
} else if s.otelConfig.enablePrometheusExporter {
options = append(options, otel.WithMeterProvider(append(meterProviderOptions,
otel.WithPrometheusExporter(s.prometheusRegisterer),
)...))
}
tp, mp, err := s.otelManager.Setup(ctx, res, options...)
if err != nil {
return fmt.Errorf("failed to setup open telemetry: %w", err)
}
if tp != nil {
s.tracerProvider = tp
}
s.noopMeter = noopMetric.NewMeterProvider().Meter(defaultMeterName)
if mp != nil {
s.meter = mp.Meter(defaultMeterName)
} else {
s.meter = s.noopMeter
}
if s.otelConfig.enablePrometheusExporter && s.otelConfig.prometheusMetricsPort > 0 {
s.httpServerShutdownComplete = make(chan struct{})
s.httpServer = &http.Server{
Addr: fmt.Sprintf(":%d", s.otelConfig.prometheusMetricsPort),
Handler: promhttp.InstrumentMetricHandler(
s.prometheusRegisterer, promhttp.HandlerFor(s.prometheusGatherer, promhttp.HandlerOpts{
ErrorLog: &prometheusLogger{l: s.logger},
}),
),
}
goFactory.Go(func() {
defer close(s.httpServerShutdownComplete)
if err := s.httpServer.ListenAndServe(); !errors.Is(err, http.ErrServerClosed) {
s.logger.Fatalf("Prometheus exporter failed: %v", err)
}
})
}
// Starting background collection
var backgroundCollectionCtx context.Context
backgroundCollectionCtx, s.stopBackgroundCollection = context.WithCancel(context.Background())
gaugeFunc := func(key string, val uint64) {
s.getMeasurement("runtime_"+key, GaugeType, nil).Gauge(val)
}
s.metricsStatsCollector = newMetricStatsCollector(s, s.config.periodicStatsConfig.metricManager)
goFactory.Go(func() {
s.metricsStatsCollector.run(backgroundCollectionCtx)
})
if s.config.periodicStatsConfig.enabled {
s.runtimeStatsCollector = newRuntimeStatsCollector(gaugeFunc)
s.runtimeStatsCollector.PauseDur = time.Duration(s.config.periodicStatsConfig.statsCollectionInterval) * time.Second
s.runtimeStatsCollector.EnableCPU = s.config.periodicStatsConfig.enableCPUStats
s.runtimeStatsCollector.EnableMem = s.config.periodicStatsConfig.enableMemStats
s.runtimeStatsCollector.EnableGC = s.config.periodicStatsConfig.enableGCStats
goFactory.Go(func() {
s.runtimeStatsCollector.run(backgroundCollectionCtx)
})
}
if s.otelConfig.enablePrometheusExporter {
s.logger.Infof("Stats started in Prometheus mode on :%d", s.otelConfig.prometheusMetricsPort)
} else {
s.logger.Infof("Stats started in OpenTelemetry mode with metrics endpoint %q and traces endpoint %q",
s.otelConfig.metricsEndpoint, s.otelConfig.tracesEndpoint,
)
}
return nil
}
func (s *otelStats) Stop() {
if !s.config.enabled.Load() {
return
}
ctx, cancel := context.WithTimeout(context.TODO(), 10*time.Second)
defer cancel()
if err := s.otelManager.Shutdown(ctx); err != nil {
s.logger.Errorf("failed to shutdown open telemetry: %v", err)
}
s.stopBackgroundCollection()
if s.metricsStatsCollector.done != nil {
<-s.metricsStatsCollector.done
}
if s.config.periodicStatsConfig.enabled && s.runtimeStatsCollector.done != nil {
<-s.runtimeStatsCollector.done
}
if s.httpServer != nil && s.httpServerShutdownComplete != nil {
if err := s.httpServer.Shutdown(ctx); err != nil {
s.logger.Errorf("failed to shutdown prometheus exporter: %v", err)
}
<-s.httpServerShutdownComplete
}
}
// NewTracer allows you to create a tracer for creating spans
func (s *otelStats) NewTracer(name string) Tracer {
s.tracerMapMu.Lock()
defer s.tracerMapMu.Unlock()
if s.tracerMap == nil {
s.tracerMap = make(map[string]Tracer)
} else if t, ok := s.tracerMap[name]; ok {
return t
}
var attrs []attribute.KeyValue
if len(s.traceBaseAttributes) > 0 {
attrs = append(attrs, s.traceBaseAttributes...)
}
if s.config.serviceName != "" {
attrs = append(attrs, semconv.ServiceNameKey.String(s.config.serviceName))
}
opts := []trace.TracerOption{
trace.WithInstrumentationVersion(s.config.serviceVersion),
}
if len(attrs) > 0 {
opts = append(opts, trace.WithInstrumentationAttributes(attrs...))
}
s.tracerMap[name] = &tracer{
tracer: s.tracerProvider.Tracer(name, opts...),
}
return s.tracerMap[name]
}
// NewStat creates a new Measurement with provided Name and Type
func (s *otelStats) NewStat(name, statType string) (m Measurement) {
return s.getMeasurement(name, statType, nil)
}
// NewTaggedStat creates a new Measurement with provided Name, Type and Tags
func (s *otelStats) NewTaggedStat(name, statType string, tags Tags) (m Measurement) {
return s.getMeasurement(name, statType, tags)
}
// NewSampledTaggedStat creates a new Measurement with provided Name, Type and Tags
// Deprecated: use NewTaggedStat instead
func (s *otelStats) NewSampledTaggedStat(name, statType string, tags Tags) (m Measurement) {
return s.NewTaggedStat(name, statType, tags)
}
func (*otelStats) getNoOpMeasurement(statType string) Measurement {
om := &otelMeasurement{
genericMeasurement: genericMeasurement{statType: statType},
disabled: true,
}
switch statType {
case CountType:
return &otelCounter{otelMeasurement: om}
case GaugeType:
return &otelGauge{otelMeasurement: om}
case TimerType:
return &otelTimer{otelMeasurement: om}
case HistogramType:
return &otelHistogram{otelMeasurement: om}
}
panic(fmt.Errorf("unsupported measurement type %s", statType))
}
func (s *otelStats) getMeasurement(name, statType string, tags Tags) Measurement {
if !s.config.enabled.Load() {
return s.getNoOpMeasurement(statType)
}
if strings.Trim(name, " ") == "" {
byteArr := make([]byte, 2048)
n := runtime.Stack(byteArr, false)
stackTrace := string(byteArr[:n])
s.logger.Warnf("detected missing stat measurement name, using 'novalue':\n%v", stackTrace)
name = "novalue"
}
// Clean up tags based on deployment type. No need to send workspace id tag for free tier customers.
newTags := make(Tags)
for k, v := range tags {
if strings.Trim(k, " ") == "" {
s.logger.Warnf("removing empty tag key with value %q for measurement %q", v, name)
continue
}
if _, ok := s.config.excludedTags[k]; ok {
continue
}
sanitizedKey := sanitizeTagKey(k)
if _, ok := s.config.excludedTags[sanitizedKey]; ok {
continue
}
if _, ok := s.resourceAttrs[sanitizedKey]; ok {
s.logger.Warnf("removing tag %q for measurement %q since it is a resource attribute", k, name)
continue
}
newTags[sanitizedKey] = v
}
om := &otelMeasurement{
genericMeasurement: genericMeasurement{statType: statType},
attributes: newTags.otelAttributes(),
}
switch statType {
case CountType:
instr := buildOTelInstrument(s.meter, s.noopMeter, name, s.counters, &s.countersMu, s.logger)
return &otelCounter{counter: instr, otelMeasurement: om}
case GaugeType:
return s.getGauge(name, om.attributes, newTags.String())
case TimerType:
instr := buildOTelInstrument(s.meter, s.noopMeter, name, s.timers, &s.timersMu, s.logger)
return &otelTimer{timer: instr, otelMeasurement: om}
case HistogramType:
instr := buildOTelInstrument(s.meter, s.noopMeter, name, s.histograms, &s.histogramsMu, s.logger)
return &otelHistogram{histogram: instr, otelMeasurement: om}
default:
panic(fmt.Errorf("unsupported measurement type %s", statType))
}
}
func (s *otelStats) getGauge(
name string, attributes []attribute.KeyValue, tagsKey string,
) *otelGauge {
var (
ok bool
og *otelGauge
mapKey = name + "|" + tagsKey
)
s.gaugesMu.Lock()
defer s.gaugesMu.Unlock()
if s.gauges == nil {
s.gauges = make(map[string]*otelGauge)
} else {
og, ok = s.gauges[mapKey]
}
if !ok {
og = &otelGauge{otelMeasurement: &otelMeasurement{
genericMeasurement: genericMeasurement{statType: GaugeType},
attributes: attributes,
}}
g, err := s.meter.Float64ObservableGauge(name)
if err != nil {
s.logger.Warnf("failed to create gauge %s: %v", name, err)
g, _ = s.noopMeter.Float64ObservableGauge(name)
} else {
_, err = s.meter.RegisterCallback(func(ctx context.Context, o metric.Observer) error {
if value := og.getValue(); value != nil {
o.ObserveFloat64(g, cast.ToFloat64(value), metric.WithAttributes(attributes...))
}
return nil
}, g)
if err != nil {
panic(fmt.Errorf("failed to register callback for gauge %s: %w", name, err))
}
}
s.gauges[mapKey] = og
}
return og
}
func buildOTelInstrument[T any](
meter, noopMeter metric.Meter,
name string, m map[string]T, mu *sync.Mutex,
l logger.Logger,
) T {
var (
ok bool
instr T
)
mu.Lock()
defer mu.Unlock()
if m == nil {
m = make(map[string]T)
} else {
instr, ok = m[name]
}
if !ok {
var err error
var value interface{}
switch any(m).(type) {
case map[string]metric.Int64Counter:
if value, err = meter.Int64Counter(name); err != nil {
value, _ = noopMeter.Int64Counter(name)
}
case map[string]metric.Float64Histogram:
if value, err = meter.Float64Histogram(name); err != nil {
value, _ = noopMeter.Float64Histogram(name)
}
default:
panic(fmt.Errorf("unknown instrument type %T", instr))
}
if err != nil {
l.Warnf("failed to create instrument %T(%s): %v", instr, name, err)
}
instr = value.(T)
m[name] = instr
}
return instr
}
type otelStatsConfig struct {
tracesEndpoint string
tracingSamplingRate float64
withTracingSyncer bool
withZipkin bool
metricsEndpoint string
metricsExportInterval time.Duration
enablePrometheusExporter bool
prometheusMetricsPort int
}
type prometheusLogger struct{ l logger.Logger }
func (p *prometheusLogger) Println(v ...interface{}) { p.l.Error(v...) }