1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-04 09:43:23 +02:00
opentelemetry-go/README.md
Mike Goldsmith 2ccddfe82a
Update README with import instructions and how to build / test (#505)
* update README with import instructions and how to build / test

* fix typo

* remove building the code section from README.md

* add clone instructions to CONTRIBUTING.md

Co-authored-by: Joshua MacDonald <jmacd@users.noreply.github.com>
Co-authored-by: Rahul Patel <rahulpa@google.com>
2020-03-12 09:52:12 -07:00

4.6 KiB

OpenTelemetry-Go

Circle CI Docs Go Report Card Gitter

The Go OpenTelemetry client.

Installation

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:

Quick Start

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.

Compatible Exporters

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.

Contributing

See the contributing file.

Release Schedule

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 Target Date Release Date
Tracing API Alpha v0.1.0 October 28 2019 November 05 2019
Tracing SDK Alpha v0.1.0 October 28 2019 November 05 2019
Jaeger Trace Exporter Alpha v0.1.0 October 28 2019 November 05 2019
Trace Context Propagation Alpha v0.1.0 Unknown November 05 2019
OpenTracing Bridge Alpha v0.1.0 October November 05 2019
Metrics API Alpha v0.2.0 October 28 2019 December 03 2019
Metrics SDK Alpha v0.2.0 October 28 2019 December 03 2019
Prometheus Metrics Exporter Alpha v0.2.0 October 28 2019 December 03 2019
Context Prop. rename/Baggage Alpha v0.3.0 December 23 2019 -
OpenTelemetry Collector Exporter Alpha v0.4.0 January 15 2020 -
Zipkin Trace Exporter Alpha Unknown -
OpenCensus Bridge Alpha Unknown -