chore: Expanding lll coverage to telemetry

Author: yhakbar

.golangci.yml

@@ -121,7 +121,7 @@ linters:
       # trying to get this merged in.
       - linters:
           - lll
-        path-except: '^(internal/awshelper/|internal/cas/|internal/cli/commands/(backend/(delete|migrate)|catalog/tui/command|dag/graph|exec|find|help|list|scaffold|stack)/|internal/cloner/|internal/configbridge/|internal/engine/|internal/errorconfig/|internal/errors/|internal/experiment/|internal/gcphelper/|internal/git/|internal/os/exec/|internal/prepare/|internal/queue/|internal/runner/(common|graph|run/creds|runcfg)/|internal/stacks/(generate|output)/|internal/tf/cache/(controllers|middleware)/|internal/tflint/|internal/tips/|internal/vfs/|internal/worktrees/|pkg/log/(format/(options|placeholders)|writer)/)'
+        path-except: '^(internal/awshelper/|internal/cas/|internal/cli/commands/(backend/(delete|migrate)|catalog/tui/command|dag/graph|exec|find|help|list|scaffold|stack)/|internal/cloner/|internal/configbridge/|internal/engine/|internal/errorconfig/|internal/errors/|internal/experiment/|internal/gcphelper/|internal/git/|internal/os/exec/|internal/prepare/|internal/queue/|internal/runner/(common|graph|run/creds|runcfg)/|internal/stacks/(generate|output)/|internal/telemetry/|internal/tf/cache/(controllers|middleware)/|internal/tflint/|internal/tips/|internal/vfs/|internal/worktrees/|pkg/log/(format/(options|placeholders)|writer)/)'
     paths:
       - docs
       - _ci

internal/telemetry/context.go

@@ -31,7 +31,8 @@ func TelemeterFromContext(ctx context.Context) *Telemeter {
 	return new(Telemeter)
 }
 
-// TraceParentFromContext returns the W3C traceparent header value from the context's span, or an error if not available.
+// TraceParentFromContext returns the W3C traceparent header value from
+// the context's span, or an error if not available.
 func TraceParentFromContext(ctx context.Context, telemetry *Options) string {
 	span := trace.SpanFromContext(ctx)
 	spanContext := span.SpanContext()

internal/telemetry/meter.go

@@ -71,7 +71,9 @@ func NewMeter(ctx context.Context, appName, appVersion string, writer io.Writer,
 }
 
 // Time collects time for function execution
-func (meter *Meter) Time(ctx context.Context, name string, attrs map[string]any, fn func(childCtx context.Context) error) error {
+func (meter *Meter) Time(
+	ctx context.Context, name string, attrs map[string]any, fn func(childCtx context.Context) error,
+) error {
 	if meter == nil || meter.exporter == nil {
 		return fn(ctx)
 	}

internal/telemetry/opts.go

@@ -10,8 +10,10 @@ type Options struct {
 	TraceParent string
 	// MetricExporter is the type of metrics exporter.
 	MetricExporter string
-	// TraceExporterInsecureEndpoint is useful for collecting traces locally. If set to true, the exporter will not validate the server certificate.
+	// TraceExporterInsecureEndpoint is useful for collecting traces locally.
+	// If set to true, the exporter will not validate the server certificate.
 	TraceExporterInsecureEndpoint bool
-	// MetricExporterInsecureEndpoint is useful for local metrics collection. if set to true, the exporter will not validate the server's certificate.
+	// MetricExporterInsecureEndpoint is useful for local metrics collection.
+	// If set to true, the exporter will not validate the server's certificate.
 	MetricExporterInsecureEndpoint bool
 }

internal/telemetry/telemeter.go

@@ -17,7 +17,9 @@ type Telemeter struct {
 }
 
 // NewTelemeter initializes the telemetry collector.
-func NewTelemeter(ctx context.Context, l log.Logger, appName, appVersion string, writer io.Writer, opts *Options) (*Telemeter, error) {
+func NewTelemeter(
+	ctx context.Context, l log.Logger, appName, appVersion string, writer io.Writer, opts *Options,
+) (*Telemeter, error) {
 	tracer, err := NewTracer(ctx, l, appName, appVersion, writer, opts)
 	if err != nil {
 		return nil, errors.New(err)
@@ -61,7 +63,9 @@ func (tlm *Telemeter) Shutdown(ctx context.Context) error {
 }
 
 // Collect collects telemetry from function execution metrics and traces.
-func (tlm *Telemeter) Collect(ctx context.Context, name string, attrs map[string]any, fn func(childCtx context.Context) error) error {
+func (tlm *Telemeter) Collect(
+	ctx context.Context, name string, attrs map[string]any, fn func(childCtx context.Context) error,
+) error {
 	if tlm == nil {
 		// This should not happen in normal operation. Log a stack trace to help
 		// diagnose if this nil guard is the one preventing a panic.

internal/telemetry/tracer.go

@@ -45,7 +45,9 @@ type Tracer struct {
 }
 
 // NewTracer creates and configures the traces collection.
-func NewTracer(ctx context.Context, l log.Logger, appName, appVersion string, writer io.Writer, opts *Options) (*Tracer, error) {
+func NewTracer(
+	ctx context.Context, l log.Logger, appName, appVersion string, writer io.Writer, opts *Options,
+) (*Tracer, error) {
 	spanExporter, err := NewTraceExporter(ctx, writer, opts)
 	if err != nil {
 		return nil, errors.New(err)
@@ -116,7 +118,9 @@ func NewTracer(ctx context.Context, l log.Logger, appName, appVersion string, wr
 }
 
 // newTraceProvider creates a new trace tracer with terragrunt version.
-func newTraceProvider(exp sdktrace.SpanExporter, appName, appVersion string, opts *Options) (*sdktrace.TracerProvider, error) {
+func newTraceProvider(
+	exp sdktrace.SpanExporter, appName, appVersion string, opts *Options,
+) (*sdktrace.TracerProvider, error) {
 	r, err := resource.Merge(
 		resource.Default(),
 		resource.NewWithAttributes(
@@ -190,7 +194,9 @@ func NewTraceExporter(ctx context.Context, writer io.Writer, opts *Options) (sdk
 }
 
 // Trace collects traces for method execution.
-func (tracer *Tracer) Trace(ctx context.Context, name string, attrs map[string]any, fn func(childCtx context.Context) error) error {
+func (tracer *Tracer) Trace(
+	ctx context.Context, name string, attrs map[string]any, fn func(childCtx context.Context) error,
+) error {
 	if tracer == nil || tracer.spanExporter == nil || tracer.provider == nil { // invoke function without tracing
 		return fn(ctx)
 	}
@@ -199,7 +205,10 @@ func (tracer *Tracer) Trace(ctx context.Context, name string, attrs map[string]a
 
 	if span == nil {
 		if tracer.l != nil {
-			tracer.l.Debugf("openSpan returned nil span for %q (provider may have been shut down), bypassing tracing. Stack:\n%s", name, debug.Stack())
+			tracer.l.Debugf(
+				"openSpan returned nil span for %q (provider may have been shut down), bypassing tracing. Stack:\n%s",
+				name, debug.Stack(),
+			)
 		}
 
 		return fn(ctx)