The Go OpenTelemetry client.
This repository includes multiple packages. The api
package contains core data types, interfaces and no-op implementations that comprise the OpenTelemetry API following
the
specification.
The sdk package is the reference implementation of the API.
Libraries that produce telemetry data should only depend on api
and defer the choice of the SDK to the application developer. Applications may
depend on sdk or another package that implements the API.
All packages are published to go.opentelemetry.io/otel and is the preferred location to import from.
Additional resources:
Below is a brief example of importing OpenTelemetry, initializing a tracer and creating some simple spans.
package main
import (
"context"
"log"
"go.opentelemetry.io/otel/api/global"
"go.opentelemetry.io/otel/exporters/trace/stdout"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
)
func initTracer() {
exporter, err := stdout.NewExporter(stdout.Options{PrettyPrint: true})
if err != nil {
log.Fatal(err)
}
tp, err := sdktrace.NewProvider(sdktrace.WithConfig(sdktrace.Config{DefaultSampler: sdktrace.AlwaysSample()}),
sdktrace.WithSyncer(exporter))
if err != nil {
log.Fatal(err)
}
global.SetTraceProvider(tp)
}
func main() {
initTracer()
tracer := global.Tracer("ex.com/basic")
tracer.WithSpan(context.Background(), "foo",
func(ctx context.Context) error {
tracer.WithSpan(ctx, "bar",
func(ctx context.Context) error {
tracer.WithSpan(ctx, "baz",
func(ctx context.Context) error {
return nil
},
)
return nil
},
)
return nil
},
)
}See the API documentation for more detail, and the opentelemetry-example-app for a complete example.
See the Go packages depending upon sdk/export/trace and sdk/export/metric for a list of all exporters compatible with OpenTelemetry's Go SDK.
See the opentelemetry-go-contrib repo for packages that facilitates instrumenting other useful Go libraries with opentelemetry-go for distributed tracing and monitoring.
See the contributing file.
OpenTelemetry Go is under active development. Below is the release schedule for the Go library. The first version of the release isn't guaranteed to conform to a specific version of the specification, and future releases will not attempt to maintain backward compatibility with the alpha release.
| Component | Version | Release Date |
|---|---|---|
| Tracing API | Alpha v0.1.0 | November 05 2019 |
| Tracing SDK | Alpha v0.1.0 | November 05 2019 |
| Jaeger Trace Exporter | Alpha v0.1.0 | November 05 2019 |
| Trace Context Propagation | Alpha v0.1.0 | November 05 2019 |
| OpenTracing Bridge | Alpha v0.1.0 | November 05 2019 |
| Metrics API | Alpha v0.2.0 | December 03 2019 |
| Metrics SDK | Alpha v0.2.0 | December 03 2019 |
| Prometheus Metrics Exporter | Alpha v0.2.0 | December 03 2019 |
| Context Prop. rename/Baggage | Beta v0.4.0 | March 30 2020 |
| OpenTelemetry Collector Exporter | Beta v0.4.0 | March 30 2020 |
| Zipkin Trace Exporter | Beta v0.4.0 | March 30 2020 |
| OTLP Trace & Metrics Exporter | Beta v0.4.0 | March 30 2020 |