-
Notifications
You must be signed in to change notification settings - Fork 9
/
wire.go
321 lines (259 loc) · 9.06 KB
/
wire.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
// Copyright 2022 Namespace Labs Inc; All rights reserved.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
package tracing
import (
"context"
"errors"
"flag"
"fmt"
"net/http"
"os"
"strings"
"sync"
"time"
"github.com/google/uuid"
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/exporters/stdout/stdouttrace"
"go.opentelemetry.io/otel/propagation"
"go.opentelemetry.io/otel/sdk/metric"
"go.opentelemetry.io/otel/sdk/resource"
"go.opentelemetry.io/otel/sdk/trace"
semconv "go.opentelemetry.io/otel/semconv/v1.21.0"
oteltrace "go.opentelemetry.io/otel/trace"
t "go.opentelemetry.io/otel/trace"
"go.opentelemetry.io/otel/trace/noop"
"golang.org/x/exp/slices"
"google.golang.org/grpc"
"namespacelabs.dev/foundation/schema"
"namespacelabs.dev/foundation/std/core/types"
"namespacelabs.dev/foundation/std/go/core"
)
var (
tracingShutdownTimeout = flag.Duration("tracing_shutdown_timeout", 5*time.Second, "How long to wait for the tracer to shutdown.")
global struct {
mu sync.Mutex
initialized bool
exporters []trace.SpanExporter
metricExporters []metric.Exporter
detectors []resource.Detector
tracerProvider t.TracerProvider // We don't use otel's global, to ensure that dependency order is respected.
}
propagators = propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{})
instanceID = uuid.New().String()
)
type Exporter struct {
name string
}
func (e Exporter) Register(exp trace.SpanExporter) error {
global.mu.Lock()
defer global.mu.Unlock()
if global.initialized {
return errors.New("Exporter.Register after initialization was complete")
}
global.exporters = append(global.exporters, exp)
return nil
}
func (e Exporter) RegisterMetrics(exp metric.Exporter) error {
global.mu.Lock()
defer global.mu.Unlock()
if global.initialized {
return errors.New("Exporter.Register after initialization was complete")
}
global.metricExporters = append(global.metricExporters, exp)
return nil
}
func ProvideExporter(_ context.Context, args *ExporterArgs, _ ExtensionDeps) (Exporter, error) {
return Exporter{args.Name}, nil
}
type Detector struct {
name string
}
func (e Detector) Register(detector resource.Detector) error {
global.mu.Lock()
defer global.mu.Unlock()
if global.initialized {
return errors.New("Detector.Register after initialization was complete")
}
global.detectors = append(global.detectors, detector)
return nil
}
func ProvideDetector(_ context.Context, args *DetectorArgs, _ ExtensionDeps) (Detector, error) {
return Detector{args.Name}, nil
}
func CreateResource(ctx context.Context, serverInfo *types.ServerInfo, detectors []resource.Detector) (*resource.Resource, error) {
return resource.New(ctx,
resource.WithSchemaURL(semconv.SchemaURL),
resource.WithOS(),
resource.WithProcessRuntimeName(),
resource.WithProcessRuntimeVersion(),
resource.WithProcessRuntimeDescription(),
resource.WithDetectors(detectors...),
resource.WithAttributes(
semconv.ServiceNameKey.String(serverInfo.ServerName),
semconv.ServiceVersionKey.String(serverInfo.GetVcs().GetRevision()),
semconv.ServiceInstanceIDKey.String(instanceID),
semconv.DeploymentEnvironmentKey.String(serverInfo.EnvName),
attribute.String("environment", serverInfo.EnvName),
),
)
}
func CreateProvider(ctx context.Context, serverInfo *types.ServerInfo, exporters []trace.SpanExporter, detectors []resource.Detector) (t.TracerProvider, core.CtxCloseable, error) {
if len(exporters) == 0 {
if os.Getenv("FOUNDATION_TRACE_TO_STDOUT") != "1" {
return noop.NewTracerProvider(), nil, nil
}
out, err := stdouttrace.New()
if err != nil {
return nil, nil, err
}
exporters = append(exporters, out)
}
var opts []trace.TracerProviderOption
for _, exp := range exporters {
if core.EnvIs(schema.Environment_PRODUCTION) {
opts = append(opts, trace.WithBatcher(exp, trace.WithBatchTimeout(10*time.Second)))
} else {
opts = append(opts, trace.WithSyncer(exp))
}
}
resource, err := CreateResource(ctx, serverInfo, detectors)
if err != nil {
return nil, nil, fmt.Errorf("failed to create resource: %w", err)
}
opts = append(opts, trace.WithResource(resource))
tp := trace.NewTracerProvider(opts...)
return tp, close{tp}, nil
}
func Prepare(ctx context.Context, deps ExtensionDeps) error {
provider, closeable, err := CreateProvider(ctx, deps.ServerInfo, consumeExporters(), consumeDetectors())
if err != nil {
return err
}
serverResources := core.ServerResourcesFrom(ctx)
if serverResources != nil && closeable != nil {
serverResources.Add(closeable)
}
filter := func(*otelgrpc.InterceptorInfo) bool { return true } // By default we trace every gRPC method
if skipStr := os.Getenv("FOUNDATION_GRPCTRACE_SKIP_METHODS"); skipStr != "" {
skipTraces := strings.Split(skipStr, ",")
filter = func(info *otelgrpc.InterceptorInfo) bool {
if info != nil {
if slices.Contains(skipTraces, info.Method) {
return false
}
if info.UnaryServerInfo != nil && slices.Contains(skipTraces, info.UnaryServerInfo.FullMethod) {
return false
}
if info.StreamServerInfo != nil && slices.Contains(skipTraces, info.StreamServerInfo.FullMethod) {
return false
}
}
return true
}
}
uni := otelgrpc.UnaryServerInterceptor(otelgrpc.WithTracerProvider(provider), otelgrpc.WithPropagators(propagators),
otelgrpc.WithInterceptorFilter(filter))
stream := otelgrpc.StreamServerInterceptor(otelgrpc.WithTracerProvider(provider), otelgrpc.WithPropagators(propagators),
otelgrpc.WithMessageEvents(), otelgrpc.WithInterceptorFilter(filter))
deps.Interceptors.ForServer(func(ctx context.Context, req any, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (any, error) {
return uni(ctx, req, info, func(ctx context.Context, req any) (any, error) {
span := t.SpanFromContext(ctx)
if t, ok := ctx.Deadline(); ok {
span.SetAttributes(attribute.Int64("rpc.deadline_left_ms", time.Until(t).Milliseconds()))
}
return handler(ctx, req)
})
}, func(srv any, ss grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error {
return stream(srv, ss, info, func(srv any, stream grpc.ServerStream) error {
span := t.SpanFromContext(stream.Context())
if t, ok := ctx.Deadline(); ok {
span.SetAttributes(attribute.Int64("rpc.deadline_left_ms", time.Until(t).Milliseconds()))
}
return handler(srv, stream)
})
})
deps.Interceptors.ForClient(
otelgrpc.UnaryClientInterceptor(otelgrpc.WithTracerProvider(provider), otelgrpc.WithPropagators(propagators),
otelgrpc.WithInterceptorFilter(filter)),
otelgrpc.StreamClientInterceptor(otelgrpc.WithTracerProvider(provider), otelgrpc.WithPropagators(propagators),
otelgrpc.WithMessageEvents(), otelgrpc.WithInterceptorFilter(filter)),
)
deps.Middleware.Add(func(h http.Handler) http.Handler {
return otelhttp.NewHandler(h, "",
otelhttp.WithTracerProvider(provider),
otelhttp.WithSpanNameFormatter(func(_ string, r *http.Request) string {
return fmt.Sprintf("%s %s", r.Method, r.URL.Path)
}))
})
global.mu.Lock()
global.tracerProvider = provider
global.mu.Unlock()
return nil
}
func consumeExporters() []trace.SpanExporter {
global.mu.Lock()
defer global.mu.Unlock()
exporters := global.exporters
global.initialized = true
return exporters
}
func consumeMetricsExporters() []metric.Exporter {
global.mu.Lock()
defer global.mu.Unlock()
exporters := global.metricExporters
global.initialized = true
return exporters
}
func consumeDetectors() []resource.Detector {
global.mu.Lock()
defer global.mu.Unlock()
detectors := global.detectors
global.initialized = true
return detectors
}
type close struct {
tp *trace.TracerProvider
}
func (c close) Close(ctx context.Context) error {
ctxWithTimeout, cancel := context.WithTimeout(ctx, *tracingShutdownTimeout)
defer cancel()
return c.tp.Shutdown(ctxWithTimeout)
}
func getTracerProvider() (t.TracerProvider, error) {
global.mu.Lock()
defer global.mu.Unlock()
if !global.initialized {
return nil, errors.New("tried to get a non-initialized TracerProvider; you need to use initializeAfter")
}
return global.tracerProvider, nil
}
type DeferredTracerProvider interface {
GetTracerProvider() (t.TracerProvider, error)
}
func ProvideTracerProvider(context.Context, *NoArgs, ExtensionDeps) (DeferredTracerProvider, error) {
return deferredTracerProvider{}, nil
}
type deferredTracerProvider struct{}
func (deferredTracerProvider) GetTracerProvider() (t.TracerProvider, error) {
return getTracerProvider()
}
func Tracer(pkg *core.Package, p DeferredTracerProvider) (oteltrace.Tracer, error) {
tracer, err := p.GetTracerProvider()
if err != nil {
return nil, err
}
if tracer == nil {
return nil, nil
}
return tracer.Tracer(pkg.PackageName), nil
}
func MustTracer(pkg *core.Package, p DeferredTracerProvider) oteltrace.Tracer {
t, err := Tracer(pkg, p)
if err != nil {
panic(err)
}
return t
}