sigs.k8s.io/cluster-api-provider-azure@v1.14.3/pkg/ot/traces.go (about)

     1  /*
     2  Copyright 2021 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package ot
    18  
    19  import (
    20  	"context"
    21  	"time"
    22  
    23  	"github.com/go-logr/logr"
    24  	"github.com/pkg/errors"
    25  	"go.opentelemetry.io/otel"
    26  	"go.opentelemetry.io/otel/attribute"
    27  	"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
    28  	"go.opentelemetry.io/otel/propagation"
    29  	"go.opentelemetry.io/otel/sdk/resource"
    30  	sdktrace "go.opentelemetry.io/otel/sdk/trace"
    31  	semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
    32  	"sigs.k8s.io/cluster-api-provider-azure/version"
    33  )
    34  
    35  // RegisterTracing enables code tracing via OpenTelemetry.
    36  func RegisterTracing(ctx context.Context, log logr.Logger) error {
    37  	tp, err := otlpTracerProvider(ctx, "opentelemetry-collector:4317")
    38  	if err != nil {
    39  		return err
    40  	}
    41  	otel.SetTracerProvider(tp)
    42  
    43  	// Give the tracer provider 5 seconds to shut down when the context closes.
    44  	go func() {
    45  		<-ctx.Done()
    46  		ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
    47  		defer cancel()
    48  		if err := tp.Shutdown(ctx); err != nil {
    49  			log.Error(err, "failed to shut down tracer provider")
    50  		}
    51  	}()
    52  
    53  	return nil
    54  }
    55  
    56  // otlpTracerProvider initializes an OTLP exporter and configures the corresponding tracer provider.
    57  func otlpTracerProvider(ctx context.Context, url string) (*sdktrace.TracerProvider, error) {
    58  	res, err := resource.New(ctx,
    59  		resource.WithAttributes(
    60  			semconv.ServiceNameKey.String("capz"),
    61  			attribute.String("exporter", "otlp"),
    62  			attribute.String("version", version.Get().String()),
    63  			attribute.String("azuresdk.version", version.Get().AzureSdkVersion),
    64  		),
    65  	)
    66  	if err != nil {
    67  		return nil, errors.Wrap(err, "failed to create opentelemetry resource")
    68  	}
    69  
    70  	traceExporter, err := otlptracegrpc.New(ctx,
    71  		otlptracegrpc.WithInsecure(),
    72  		otlptracegrpc.WithEndpoint(url),
    73  	)
    74  	if err != nil {
    75  		return nil, errors.Wrap(err, "failed to create otlp trace exporter")
    76  	}
    77  
    78  	bsp := sdktrace.NewBatchSpanProcessor(traceExporter)
    79  	tracerProvider := sdktrace.NewTracerProvider(
    80  		sdktrace.WithSampler(sdktrace.AlwaysSample()),
    81  		sdktrace.WithResource(res),
    82  		sdktrace.WithSpanProcessor(bsp),
    83  	)
    84  	otel.SetTracerProvider(tracerProvider)
    85  	otel.SetTextMapPropagator(propagation.TraceContext{})
    86  
    87  	return tracerProvider, nil
    88  }