-
Notifications
You must be signed in to change notification settings - Fork 0
/
otel.go
107 lines (96 loc) · 3.58 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
// Package clotel provides re-usable components for OpenTelemetry integration
package clotel
import (
"context"
"fmt"
"strings"
"github.com/crewlinker/clgo/clconfig"
"go.opentelemetry.io/contrib/detectors/aws/ecs"
"go.opentelemetry.io/contrib/propagators/aws/xray"
"go.opentelemetry.io/otel/exporters/otlp/otlptrace"
"go.opentelemetry.io/otel/metric"
"go.opentelemetry.io/otel/propagation"
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.4.0"
"go.opentelemetry.io/otel/trace"
"go.uber.org/fx"
"go.uber.org/zap"
)
// moduleName for naming conventions.
const moduleName = "clotel"
// Provide module with di setup Provide between test and prod environment.
func Provide() fx.Option {
return fx.Module(moduleName,
// provide the environment configuration
clconfig.Provide[Config](strings.ToUpper(moduleName)+"_"),
// the incoming logger will be named after the module
fx.Decorate(func(l *zap.Logger) *zap.Logger { return l.Named(moduleName) }),
// we can use the xray id generator in all cases
fx.Provide(fx.Annotate(xray.NewIDGenerator, fx.As(new(sdktrace.IDGenerator)))),
// we also provide an xray propagator for anywhere it code we need this
fx.Provide(func() propagation.TextMapPropagator {
xp := xray.Propagator{}
return xp
}),
// provide the tracer provider
fx.Provide(fx.Annotate(NewTracerProvider,
fx.OnStop(func(ctx context.Context, tp *sdktrace.TracerProvider) error {
if err := tp.Shutdown(ctx); err != nil {
return fmt.Errorf("failed to shutdown: %w", err)
}
return nil
}),
)),
// also provide as more generic interface
fx.Provide(func(tp *sdktrace.TracerProvider) trace.TracerProvider { return tp }),
// provide the metrer provider
fx.Provide(fx.Annotate(NewMeterProvider)),
// also provide as more generic interface
fx.Provide(func(mp *sdkmetric.MeterProvider) metric.MeterProvider { return mp }),
)
}
// ServiceProvide provides otel dependencies for container services.
func ServiceProvide() fx.Option {
return fx.Options(Provide(),
// service will export traces over grpc
fx.Provide(fx.Annotate(newGrpcExporter,
fx.OnStart(func(ctx context.Context, e *otlptrace.Exporter) error {
if err := e.Start(ctx); err != nil {
return fmt.Errorf("failed to start: %w", err)
}
return nil
}),
fx.OnStop(func(ctx context.Context, e *otlptrace.Exporter) error {
if err := e.Shutdown(ctx); err != nil {
return fmt.Errorf("failed to shutdown: %w", err)
}
return nil
}),
)),
// provide the grpc exporter as a generic span exporter as well
fx.Provide(func(e *otlptrace.Exporter) sdktrace.SpanExporter { return e }),
// detect expects ecs resource
fx.Provide(ecs.NewResourceDetector),
// decorate to fix an issue that prevents log correlation
fx.Decorate(WithExtraEcsAttributes),
// provide dependencies for metric export
fx.Provide(sdkmetric.NewPeriodicReader),
fx.Provide(NewMetricExporter),
)
}
// TestProvide configures the DI for a test environment.
func TestProvide() fx.Option {
return fx.Options(Provide(),
fx.Provide(fx.Annotate(sdkmetric.NewManualReader, fx.As(new(sdkmetric.Reader)))),
fx.Provide(fx.Annotate(tracetest.NewInMemoryExporter)),
fx.Provide(func(e *tracetest.InMemoryExporter) sdktrace.SpanExporter { return e }),
fx.Provide(func() resource.Detector {
return resource.StringDetector(semconv.SchemaURL, semconv.ServiceNameKey, func() (string, error) {
return "ClTest", nil
})
}),
)
}