-
Notifications
You must be signed in to change notification settings - Fork 38
/
init.go
222 lines (197 loc) · 6.91 KB
/
init.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
package telemetry
import (
"context"
"os"
"time"
"github.com/go-logr/zapr"
"go.opentelemetry.io/contrib/detectors/aws/ecs"
"go.opentelemetry.io/contrib/propagators/aws/xray"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc"
"go.opentelemetry.io/otel/exporters/otlp/otlptrace"
"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
"go.opentelemetry.io/otel/exporters/stdout/stdoutmetric"
"go.opentelemetry.io/otel/exporters/stdout/stdouttrace"
"go.opentelemetry.io/otel/metric/noop"
"go.opentelemetry.io/otel/propagation"
"go.opentelemetry.io/otel/sdk/instrumentation"
sdkmetric "go.opentelemetry.io/otel/sdk/metric"
"go.opentelemetry.io/otel/sdk/resource"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
"go.opentelemetry.io/otel/sdk/trace/tracetest"
semconv "go.opentelemetry.io/otel/semconv/v1.20.0"
"go.opentelemetry.io/otel/trace"
"go.uber.org/zap"
"github.com/transcom/mymove/pkg/telemetry/metrictest"
)
// Config defines the config necessary to enable telemetry gathering
type Config struct {
Enabled bool
Endpoint string
UseXrayID bool
SamplingFraction float64
CollectSeconds int
ReadEvents bool
WriteEvents bool
EnvironmentName string
}
const (
defaultCollectSeconds = 30
)
// Init sets up open telemetry as specified by config. It returns a
// shutdown function, and also the span and metric exporters. The
// latter two are useful in testing, but would almost certainly be
// ignored in production
func Init(logger *zap.Logger, config *Config) (func(), sdktrace.SpanExporter, sdkmetric.Exporter) {
ctx := context.Background()
var shutdown = func() {}
logger.Info("Configuring tracing", zap.Any("TelemetryConfig", config))
if !config.Enabled {
tp := trace.NewNoopTracerProvider()
otel.SetTracerProvider(tp)
otel.SetMeterProvider(noop.NewMeterProvider())
logger.Info("opentelemetry not enabled")
return shutdown, nil, nil
}
// convert our zap logger to the go-logr interface expected by
// otel, but only log otel errors
otel.SetLogger(zapr.NewLogger(logger.WithOptions(zap.IncreaseLevel(zap.ErrorLevel))))
// explicitly set error handler
otel.SetErrorHandler(otel.ErrorHandlerFunc(func(err error) {
logger.Error("opentelemetry error", zap.Error(err))
}))
var spanExporter sdktrace.SpanExporter
var metricExporter sdkmetric.Exporter
var err error
switch config.Endpoint {
case "memory":
spanExporter = tracetest.NewInMemoryExporter()
metricExporter = metrictest.NewInMemoryExporter()
case "stdout":
// explictly call WithWriter so we can override os.Stdout in tests
spanExporter, err = stdouttrace.New(stdouttrace.WithPrettyPrint(),
stdouttrace.WithWriter(os.Stdout))
if err != nil {
logger.Error("unable to create otel stdout span exporter", zap.Error(err))
break
}
// seems that maybe stdoutmetric now pretty prints by default?
metricExporter, err = stdoutmetric.New()
if err != nil {
logger.Error("unable to create otel stdout metric exporter", zap.Error(err))
break
}
default:
spanClient := otlptracegrpc.NewClient(
otlptracegrpc.WithInsecure(),
otlptracegrpc.WithEndpoint(config.Endpoint),
)
spanExporter, err = otlptrace.New(ctx, spanClient)
if err != nil {
logger.Error("failed to create otel trace exporter", zap.Error(err))
break
}
metricExporter, err = otlpmetricgrpc.New(ctx,
otlpmetricgrpc.WithInsecure(),
otlpmetricgrpc.WithEndpoint(config.Endpoint),
)
if err != nil {
logger.Error("failed to create otel metric client", zap.Error(err))
break
}
}
// Create a tracer provider that processes spans using a
// batch-span-processor.
bsp := sdktrace.NewBatchSpanProcessor(spanExporter, sdktrace.WithBatchTimeout(time.Duration(config.CollectSeconds*int(time.Second))))
sampler := sdktrace.TraceIDRatioBased(config.SamplingFraction)
resourceAttrs := []attribute.KeyValue{
semconv.ServiceNameKey.String("milmove"),
semconv.DeploymentEnvironmentKey.String(config.EnvironmentName)}
// Instantiate a new ECS resource detector
ecsResourceDetector := ecs.NewResourceDetector()
ecsResource, err := ecsResourceDetector.Detect(ctx)
if err != nil {
logger.Error("failed to create ECS resource detector", zap.Error(err))
}
var idGenerator sdktrace.IDGenerator
// we could consider automatically using xray if running in ECS,
// but they are technically orthogonal
if config.UseXrayID {
idGenerator = xray.NewIDGenerator()
}
if ecsResource.Attributes() != nil {
logger.Info("ECS resource for telemetry", zap.Any("attributes", ecsResource.Attributes()))
resourceAttrs = append(resourceAttrs, ecsResource.Attributes()...)
}
// only add a single sdktrace.WithResource option, as adding more
// than one just overwrites earlier resources
milmoveResource := resource.NewWithAttributes(semconv.SchemaURL, resourceAttrs...)
tp := sdktrace.NewTracerProvider(
sdktrace.WithResource(milmoveResource),
sdktrace.WithSampler(sampler),
sdktrace.WithIDGenerator(idGenerator),
sdktrace.WithSpanProcessor(bsp),
)
// Create pusher for metrics that runs in the background and pushes
// metrics periodically.
collectSeconds := config.CollectSeconds
if collectSeconds == 0 {
collectSeconds = defaultCollectSeconds
}
pr := sdkmetric.NewPeriodicReader(metricExporter,
sdkmetric.WithInterval(time.Duration(collectSeconds)*time.Second),
)
// create a view to filter otelhttp attributes; otherwise we have
// a memory leak as otel tracks attributes with an infinite number
// of values (e.g. user-agent)
//
// inspired by
// https://github.com/open-telemetry/opentelemetry-go-contrib/issues/3071#issuecomment-1419366500
//
otelhttpView := sdkmetric.NewView(
sdkmetric.Instrument{
Scope: instrumentation.Scope{
// this constant is not exported by otelhttp
Name: "go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp",
},
},
sdkmetric.Stream{
AttributeFilter: allowedHTTPRequestAttributeFilter,
},
)
mp := sdkmetric.NewMeterProvider(
sdkmetric.WithResource(milmoveResource),
sdkmetric.WithReader(pr),
sdkmetric.WithView(otelhttpView),
)
logger.Info("emitting tracing to local opentelemetry collector at " + config.Endpoint)
shutdown = func() {
if err = spanExporter.Shutdown(ctx); err != nil {
logger.Error("shutdown problems with tracing exporter", zap.Error(err))
}
if err = metricExporter.Shutdown(ctx); err != nil {
logger.Error("shutdown problems with metrics pusher", zap.Error(err))
}
logger.Info("Shutting down telemetry")
}
otel.SetTracerProvider(tp)
otel.SetMeterProvider(mp)
if config.UseXrayID {
otel.SetTextMapPropagator(
propagation.NewCompositeTextMapPropagator(
xray.Propagator{},
propagation.Baggage{},
propagation.TraceContext{},
),
)
} else {
otel.SetTextMapPropagator(
propagation.NewCompositeTextMapPropagator(
propagation.Baggage{},
propagation.TraceContext{},
),
)
}
return shutdown, spanExporter, metricExporter
}