OpenTelemetry Go exporter for Dynatrace

This is the home of the OpenTelemetry Go trace exporter for Dynatrace. This package allows you to export spans to Dynatrace using the OpenTelemetry API.

This package is provided as a "core package", meaning that no platform-specific span attributes are automatically provided, which might be required by Dynatrace in order to enable service detection and correlation.

Please refer to the Dynatrace documentation for how to set up tracing for Google Cloud Functions with Go using this package.

Prerequisites

You need a Dynatrace environment to export your spans to.

This package is currently only supported in specific documented scenarios on Google Cloud Functions (GCF). For GCF-specific prerequisites, please refer to Prerequisites.

Getting started

This README file just contains a very brief quickstart code sample. The main documentation of this package can be found in the Dynatrace Documentation.

Follow the instructions on how to set up the Dynatrace configuration for your project by using a config file or environment variables. An error will be returned during the TracerProvider instantiation if the configuration cannot be found or is incomplete.

1. Install the package into your Go project:

   go get github.com/dynatrace-oss/opentelemetry-exporter-go/core

2. Create a Dynatrace TracerProvider and TextMapPropagator:

   import (
       "go.opentelemetry.io/otel"
       dtTrace "github.com/dynatrace-oss/opentelemetry-exporter-go/core/trace"
   )
   
   // call this once to initialize all required tracing components in your program
   func initializeTracing() error {
       // create a TracerProvider
       tracerProvider, err := dtTrace.NewTracerProvider()
       if err != nil {
           // handle error as needed
           return err
       }
       otel.SetTracerProvider(tracerProvider)
   
       // create a TextMapPropagator
       propagator, err := dtTrace.NewTextMapPropagator()
       if err != nil {
           // handle error as needed
           return err
       }
       otel.SetTextMapPropagator(prop)
   }

3. Use the OpenTelemetry API as you normally would to create spans:

   // otel.GetTracerProvider() will now return the DtTracerProvider that was created previously, it is safe to type-assert.
   tracerProvider := otel.GetTracerProvider().(*dtTrace.DtTracerProvider)
   
   // ensure the DtTracerProvider is properly shut down when you don't need it anymore.
   // spans will be flushed, and after the deferred call executes, spans will no longer be processed or exported (even if started before)
   defer tracerProvider.Shutdown(context.Background())
   
   // create a tracer and spans
   tracer := tracerProvider.Tracer("example tracer")
   ctx, span := tracer.Start(context.Background(), "example span")
   // do something between starting and ending the span
   span.End()

Support

Before creating a support ticket, please read through the documentation.

If you didn't find a solution there, please contact Dynatrace support.

There are no SLAs for GitHub tickets.

License

Apache License Version 2.0