-
Notifications
You must be signed in to change notification settings - Fork 559
/
init.go
443 lines (385 loc) · 13.2 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
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
package telemetry
import (
"context"
"fmt"
"net"
"net/url"
"os"
"strings"
"sync"
"time"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp"
"go.opentelemetry.io/otel/log"
"go.opentelemetry.io/otel/propagation"
"go.opentelemetry.io/otel/sdk/resource"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
semconv "go.opentelemetry.io/otel/semconv/v1.24.0"
"go.opentelemetry.io/otel/trace"
"google.golang.org/grpc"
"github.com/dagger/dagger/engine/slog"
"github.com/dagger/dagger/telemetry/inflight"
"github.com/dagger/dagger/telemetry/sdklog"
"github.com/dagger/dagger/telemetry/sdklog/otlploggrpc"
"github.com/dagger/dagger/telemetry/sdklog/otlploghttp"
)
var configuredCloudSpanExporter sdktrace.SpanExporter
var configuredCloudLogsExporter sdklog.LogExporter
var ocnfiguredCloudExportersOnce sync.Once
func ConfiguredCloudExporters(ctx context.Context) (sdktrace.SpanExporter, sdklog.LogExporter, bool) {
ocnfiguredCloudExportersOnce.Do(func() {
cloudToken := os.Getenv("DAGGER_CLOUD_TOKEN")
if cloudToken == "" {
return
}
cloudURL := os.Getenv("DAGGER_CLOUD_URL")
if cloudURL == "" {
cloudURL = "https://api.dagger.cloud"
}
cloudEndpoint, err := url.Parse(cloudURL)
if err != nil {
slog.Warn("bad cloud URL", "error", err)
return
}
tracesURL := cloudEndpoint.JoinPath("v1", "traces")
logsURL := cloudEndpoint.JoinPath("v1", "logs")
headers := map[string]string{
"Authorization": "Bearer " + cloudToken,
}
configuredCloudSpanExporter, err = otlptracehttp.New(ctx,
otlptracehttp.WithEndpointURL(tracesURL.String()),
otlptracehttp.WithHeaders(headers))
if err != nil {
slog.Warn("failed to configure cloud tracing", "error", err)
return
}
cfg := otlploghttp.Config{
Endpoint: logsURL.Host,
URLPath: logsURL.Path,
Insecure: logsURL.Scheme != "https",
Headers: headers,
}
configuredCloudLogsExporter = otlploghttp.NewClient(cfg)
})
return configuredCloudSpanExporter, configuredCloudLogsExporter,
configuredCloudSpanExporter != nil
}
func OtelConfigured() bool {
for _, env := range os.Environ() {
if strings.HasPrefix(env, "OTEL_") {
return true
}
}
return false
}
var configuredSpanExporter sdktrace.SpanExporter
var configuredSpanExporterOnce sync.Once
func ConfiguredSpanExporter(ctx context.Context) (sdktrace.SpanExporter, bool) {
ctx = context.WithoutCancel(ctx)
configuredSpanExporterOnce.Do(func() {
if !OtelConfigured() {
return
}
var err error
var proto string
if v := os.Getenv("OTEL_EXPORTER_OTLP_TRACES_PROTOCOL"); v != "" {
proto = v
} else if v := os.Getenv("OTEL_EXPORTER_OTLP_PROTOCOL"); v != "" {
proto = v
} else {
// https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/protocol/exporter.md#specify-protocol
proto = "http/protobuf"
}
var endpoint string
if v := os.Getenv("OTEL_EXPORTER_OTLP_TRACES_ENDPOINT"); v != "" {
endpoint = v
} else if v := os.Getenv("OTEL_EXPORTER_OTLP_ENDPOINT"); v != "" {
if proto == "http/protobuf" {
endpoint, err = url.JoinPath(v, "v1", "traces")
if err != nil {
slog.Warn("failed to join path", "error", err)
return
}
} else {
endpoint = v
}
}
slog.ExtraDebug("configuring tracing via env", "protocol", proto)
switch proto {
case "http/protobuf", "http":
configuredSpanExporter, err = otlptracehttp.New(ctx,
otlptracehttp.WithEndpointURL(endpoint))
case "grpc":
var u *url.URL
u, err = url.Parse(endpoint)
if err != nil {
slog.Warn("bad OTLP logs endpoint %q: %w", endpoint, err)
return
}
opts := []otlptracegrpc.Option{
otlptracegrpc.WithEndpointURL(endpoint),
}
if u.Scheme == "unix" {
dialer := func(ctx context.Context, addr string) (net.Conn, error) {
return net.Dial(u.Scheme, u.Path)
}
opts = append(opts,
otlptracegrpc.WithDialOption(grpc.WithContextDialer(dialer)),
otlptracegrpc.WithInsecure())
}
configuredSpanExporter, err = otlptracegrpc.New(ctx, opts...)
default:
err = fmt.Errorf("unknown OTLP protocol: %s", proto)
}
if err != nil {
slog.Warn("failed to configure tracing", "error", err)
}
})
return configuredSpanExporter, configuredSpanExporter != nil
}
var configuredLogExporter sdklog.LogExporter
var configuredLogExporterOnce sync.Once
func ConfiguredLogExporter(ctx context.Context) (sdklog.LogExporter, bool) {
ctx = context.WithoutCancel(ctx)
configuredLogExporterOnce.Do(func() {
var err error
var endpoint string
if v := os.Getenv("OTEL_EXPORTER_OTLP_LOGS_ENDPOINT"); v != "" {
endpoint = v
} else if v := os.Getenv("OTEL_EXPORTER_OTLP_ENDPOINT"); v != "" {
// we can't assume all OTLP endpoints supprot logs. better to be
// explicit than have noisy otel errors.
slog.ExtraDebug("note: intentionally not sending logs to OTEL_EXPORTER_OTLP_ENDPOINT; set OTEL_EXPORTER_OTLP_LOGS_ENDPOINT if needed")
return
}
if endpoint == "" {
return
}
var proto string
if v := os.Getenv("OTEL_EXPORTER_OTLP_LOGS_PROTOCOL"); v != "" {
proto = v
} else if v := os.Getenv("OTEL_EXPORTER_OTLP_PROTOCOL"); v != "" {
proto = v
} else {
// https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/protocol/exporter.md#specify-protocol
proto = "http/protobuf"
}
slog.ExtraDebug("configuring logging via env", "protocol", proto, "endpoint", endpoint)
u, err := url.Parse(endpoint)
if err != nil {
slog.Warn("bad OTLP logs endpoint %q: %w", endpoint, err)
return
}
switch proto {
case "http/protobuf", "http":
cfg := otlploghttp.Config{
Endpoint: u.Host,
URLPath: u.Path,
Insecure: u.Scheme != "https",
Headers: map[string]string{},
}
if headers := os.Getenv("OTEL_EXPORTER_OTLP_HEADERS"); headers != "" {
for _, header := range strings.Split(headers, ",") {
name, value, _ := strings.Cut(header, "=")
cfg.Headers[name] = value
}
}
configuredLogExporter = otlploghttp.NewClient(cfg)
case "grpc":
opts := []otlploggrpc.Option{
otlploggrpc.WithEndpointURL(endpoint),
}
if u.Scheme == "unix" {
dialer := func(ctx context.Context, addr string) (net.Conn, error) {
return net.Dial(u.Scheme, u.Path)
}
opts = append(opts,
otlploggrpc.WithDialOption(grpc.WithContextDialer(dialer)),
otlploggrpc.WithInsecure())
}
client := otlploggrpc.NewClient(opts...)
err = client.Start(ctx)
configuredLogExporter = client
default:
err = fmt.Errorf("unknown OTLP protocol: %s", proto)
}
if err != nil {
slog.Warn("failed to configure logging", "error", err)
}
})
return configuredLogExporter, configuredLogExporter != nil
}
// FallbackResource is the fallback resource definition. A more specific
// resource should be set in Init.
func FallbackResource() *resource.Resource {
return resource.NewWithAttributes(
semconv.SchemaURL,
semconv.ServiceNameKey.String("dagger"),
)
}
var (
// set by Init, closed by Close
tracerProvider *inflight.ProxyTraceProvider
loggerProvider *sdklog.LoggerProvider
)
// LiveSpanProcessor is a SpanProcessor that can additionally receive updates
// for a span at runtime, rather than waiting until the span ends.
type LiveSpanProcessor interface {
sdktrace.SpanProcessor
// OnUpdate method enqueues a trace.ReadOnlySpan for later processing.
OnUpdate(s sdktrace.ReadOnlySpan)
}
type Config struct {
// Auto-detect exporters from OTEL_* env variables.
Detect bool
// LiveTraceExporters are exporters that can receive updates for spans at runtime,
// rather than waiting until the span ends.
//
// Example: TUI, Cloud
LiveTraceExporters []sdktrace.SpanExporter
// BatchedTraceExporters are exporters that receive spans in batches, after the
// spans have ended.
//
// Example: Honeycomb, Jaeger, etc.
BatchedTraceExporters []sdktrace.SpanExporter
// LiveLogExporters are exporters that receive logs in batches of ~100ms.
LiveLogExporters []sdklog.LogExporter
// Resource is the resource describing this component and runtime
// environment.
Resource *resource.Resource
}
// NearlyImmediate is 100ms, below which has diminishing returns in terms of
// visual perception vs. performance cost.
const NearlyImmediate = 100 * time.Millisecond
var ForceLiveTrace = os.Getenv("FORCE_LIVE_TRACE") != ""
// Logger returns a logger with the given name.
func Logger(name string) log.Logger {
return loggerProvider.Logger(name) // TODO more instrumentation attrs
}
var SpanProcessors = []sdktrace.SpanProcessor{}
var LogProcessors = []sdklog.LogProcessor{}
// Init sets up the global OpenTelemetry providers tracing, logging, and
// someday metrics providers. It is called by the CLI, the engine, and the
// container shim, so it needs to be versatile.
func Init(ctx context.Context, cfg Config) context.Context {
slog.ExtraDebug("initializing telemetry")
if p, ok := os.LookupEnv("TRACEPARENT"); ok {
slog.ExtraDebug("found TRACEPARENT", "value", p)
ctx = propagation.TraceContext{}.Extract(ctx, propagation.MapCarrier{"traceparent": p})
}
// Set up a text map propagator so that things, well, propagate. The default
// is a noop.
otel.SetTextMapPropagator(propagation.TraceContext{})
// Log to slog.
otel.SetErrorHandler(otel.ErrorHandlerFunc(func(err error) {
slog.Error("OpenTelemetry error", "error", err)
}))
if cfg.Resource == nil {
cfg.Resource = FallbackResource()
}
if cfg.Detect {
if spans, logs, ok := ConfiguredCloudExporters(ctx); ok {
cfg.LiveTraceExporters = append(cfg.LiveTraceExporters, spans)
cfg.LiveLogExporters = append(cfg.LiveLogExporters, logs)
}
if exp, ok := ConfiguredSpanExporter(ctx); ok {
if ForceLiveTrace {
cfg.LiveTraceExporters = append(cfg.LiveTraceExporters, exp)
} else {
cfg.BatchedTraceExporters = append(cfg.BatchedTraceExporters,
// Filter out unfinished spans to avoid confusing external systems.
//
// Normally we avoid sending them here by virtue of putting this into
// BatchedTraceExporters, but that only applies to the local process.
// Unfinished spans may end up here if they're proxied out of the
// engine via Params.EngineTrace.
FilterLiveSpansExporter{exp})
}
}
if exp, ok := ConfiguredLogExporter(ctx); ok {
cfg.LiveLogExporters = append(cfg.LiveLogExporters, exp)
}
}
traceOpts := []sdktrace.TracerProviderOption{
sdktrace.WithResource(cfg.Resource),
}
liveProcessors := make([]LiveSpanProcessor, 0, len(cfg.LiveTraceExporters))
for _, exporter := range cfg.LiveTraceExporters {
processor := inflight.NewBatchSpanProcessor(exporter,
inflight.WithBatchTimeout(NearlyImmediate))
liveProcessors = append(liveProcessors, processor)
SpanProcessors = append(SpanProcessors, processor)
}
for _, exporter := range cfg.BatchedTraceExporters {
processor := sdktrace.NewBatchSpanProcessor(exporter)
SpanProcessors = append(SpanProcessors, processor)
}
for _, proc := range SpanProcessors {
traceOpts = append(traceOpts, sdktrace.WithSpanProcessor(proc))
}
tracerProvider = inflight.NewProxyTraceProvider(
sdktrace.NewTracerProvider(traceOpts...),
func(s trace.Span) { // OnUpdate
if ro, ok := s.(sdktrace.ReadOnlySpan); ok && s.IsRecording() {
for _, processor := range liveProcessors {
processor.OnUpdate(ro)
}
}
},
)
// Register our TracerProvider as the global so any imported instrumentation
// in the future will default to using it.
//
// NB: this is also necessary so that we can establish a root span, otherwise
// telemetry doesn't work.
otel.SetTracerProvider(tracerProvider)
// Set up a log provider if configured.
if len(cfg.LiveLogExporters) > 0 {
lp := sdklog.NewLoggerProvider(cfg.Resource)
for _, exp := range cfg.LiveLogExporters {
processor := sdklog.NewBatchLogProcessor(exp,
sdklog.WithBatchTimeout(NearlyImmediate))
LogProcessors = append(LogProcessors, processor)
lp.RegisterLogProcessor(processor)
}
loggerProvider = lp
// TODO: someday do the following (once it exists)
// Register our TracerProvider as the global so any imported
// instrumentation in the future will default to using it.
// otel.SetLoggerProvider(loggerProvider)
}
return ctx
}
// Flush drains telemetry data, and is typically called just before a client
// goes away.
//
// NB: now that we wait for all spans to complete, this is less necessary, but
// it seems wise to keep it anyway, as the spots where it are needed are hard
// to find.
func Flush(ctx context.Context) {
slog.ExtraDebug("flushing processors")
if tracerProvider != nil {
if err := tracerProvider.ForceFlush(ctx); err != nil {
slog.Error("failed to flush spans", "error", err)
}
}
slog.ExtraDebug("done flushing processors")
}
// Close shuts down the global OpenTelemetry providers, flushing any remaining
// data to the configured exporters.
func Close() {
flushCtx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
Flush(flushCtx)
if tracerProvider != nil {
if err := tracerProvider.Shutdown(flushCtx); err != nil {
slog.Error("failed to shut down tracer provider", "error", err)
}
}
if loggerProvider != nil {
if err := loggerProvider.Shutdown(flushCtx); err != nil {
slog.Error("failed to shut down logger provider", "error", err)
}
}
}