fix: properly shutdown OpenTelemetry tracer after build completes

Move tracer shutdown from getBuildOpts to build command Run function
to ensure spans are flushed after the build completes, not immediately
after getBuildOpts returns.

- Change getBuildOpts to return shutdown function
- Update all callers to handle the new return value
- Set OTEL_EXPORTER_OTLP_ENDPOINT from CLI flag before InitTracer

Tested with Jaeger and confirmed traces are now properly sent.

Co-authored-by: Ona <no-reply@ona.com>

Author: corneliusludmann

cmd/build.go

@@ -50,7 +50,8 @@ Examples:
 		if pkg == nil {
 			log.Fatal("build needs a package")
 		}
-		opts, localCache := getBuildOpts(cmd)
+		opts, localCache, shutdown := getBuildOpts(cmd)
+		defer shutdown()
 
 		var (
 			watch, _ = cmd.Flags().GetBool("watch")
@@ -217,7 +218,7 @@ func addBuildFlags(cmd *cobra.Command) {
 	cmd.Flags().String("trace-state", os.Getenv("TRACESTATE"), "W3C Trace Context tracestate header for distributed tracing (defaults to $TRACESTATE)")
 }
 
-func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, cache.LocalCache) {
+func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, cache.LocalCache, func()) {
 	// Track if user explicitly set LEEWAY_DOCKER_EXPORT_TO_CACHE before workspace loading.
 	// This allows us to distinguish:
 	// - User set explicitly: High priority (overrides package config)
@@ -320,9 +321,15 @@ func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, cache.LocalCache) {
 
 	// Initialize OpenTelemetry reporter if endpoint is configured
 	var tracerProvider *sdktrace.TracerProvider
+	var otelShutdown func()
 	if otelEndpoint, err := cmd.Flags().GetString("otel-endpoint"); err != nil {
 		log.Fatal(err)
 	} else if otelEndpoint != "" {
+		// Set environment variable for InitTracer if not already set
+		if os.Getenv("OTEL_EXPORTER_OTLP_ENDPOINT") == "" {
+			os.Setenv("OTEL_EXPORTER_OTLP_ENDPOINT", otelEndpoint)
+		}
+		
 		// Initialize tracer
 		tp, err := telemetry.InitTracer(context.Background())
 		if err != nil {
@@ -352,14 +359,14 @@ func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, cache.LocalCache) {
 			tracer := otel.Tracer("leeway")
 			reporter = append(reporter, leeway.NewOTelReporter(tracer, parentCtx))
 
-			// Register shutdown handler
-			defer func() {
+			// Create shutdown function
+			otelShutdown = func() {
 				shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
 				defer cancel()
 				if err := telemetry.Shutdown(shutdownCtx, tracerProvider); err != nil {
 					log.WithError(err).Warn("failed to shutdown tracer provider")
 				}
-			}()
+			}
 		}
 	}
 
@@ -425,6 +432,11 @@ func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, cache.LocalCache) {
 		dockerExportSet = true
 	}
 
+	// Create a no-op shutdown function if otelShutdown is nil
+	if otelShutdown == nil {
+		otelShutdown = func() {}
+	}
+	
 	return []leeway.BuildOption{
 		leeway.WithLocalCache(localCache),
 		leeway.WithRemoteCache(remoteCache),
@@ -442,7 +454,7 @@ func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, cache.LocalCache) {
 		leeway.WithInFlightChecksums(inFlightChecksums),
 		leeway.WithDockerExportToCache(dockerExportToCache, dockerExportSet),
 		leeway.WithDockerExportEnv(dockerExportEnvValue, dockerExportEnvSet),
-	}, localCache
+	}, localCache, otelShutdown
 }
 
 type pushOnlyRemoteCache struct {

cmd/build_test.go

@@ -242,7 +242,7 @@ func TestGetBuildOptsWithInFlightChecksums(t *testing.T) {
 			}
 
 			// Test getBuildOpts function
-			opts, localCache := getBuildOpts(cmd)
+			opts, localCache, _ := getBuildOpts(cmd)
 
 			// We can't directly test the WithInFlightChecksums option since it's internal,
 			// but we can verify the function doesn't error and returns options

cmd/provenance-assert.go

@@ -125,7 +125,7 @@ func getProvenanceTarget(cmd *cobra.Command, args []string) (bundleFN, pkgFN str
 			log.Fatal("provenance export requires a package")
 		}
 
-		_, cache := getBuildOpts(cmd)
+		_, cache, _ := getBuildOpts(cmd)
 
 		var ok bool
 		pkgFN, ok = cache.Location(pkg)

cmd/run.go

@@ -27,7 +27,7 @@ Should any of the scripts fail Leeway will exit with an exit code of 1 once all
 				if script == nil {
 					return errors.New("run needs a script")
 				}
-				opts, _ := getBuildOpts(cmd)
+				opts, _, _ := getBuildOpts(cmd)
 				return script.Run(opts...)
 			})
 		}

cmd/sbom-export.go

@@ -32,7 +32,7 @@ If no package is specified, the workspace's default target is used.`,
 		}
 
 		// Get build options and cache
-		_, localCache := getBuildOpts(cmd)
+		_, localCache, _ := getBuildOpts(cmd)
 
 		// Get output format and file
 		format, _ := cmd.Flags().GetString("format")

cmd/sbom-scan.go

@@ -30,7 +30,7 @@ If no package is specified, the workspace's default target is used.`,
 		}
 
 		// Get cache
-		_, localCache := getBuildOpts(cmd)
+		_, localCache, _ := getBuildOpts(cmd)
 
 		// Get output directory
 		outputDir, _ := cmd.Flags().GetString("output-dir")

leeway-dev.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+# Helper script to run leeway from source with go run
+# Usage: ./leeway-dev.sh build :package --otel-endpoint=localhost:4318
+
+cd "$(dirname "$0")"
+exec go run . "$@"