go.opentelemetry.io

module
Version: v0.0.0-...-a71ec85 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2019 License: Apache-2.0

README

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.

To install the API and SDK packages,

$ go get -u go.opentelemetry.io

Quick Start

package main

import (
	"context"
	"log"

	apitrace "go.opentelemetry.io/api/trace"
	"go.opentelemetry.io/exporter/trace/stdout"
	sdktrace "go.opentelemetry.io/sdk/trace"
)

func initTracer() {
	sdktrace.Register()

	exporter, err := stdout.NewExporter(stdout.Options{PrettyPrint: true})
	if err != nil {
		log.Fatal(err)
	}

	ssp := sdktrace.NewSimpleSpanProcessor(exporter)
	sdktrace.RegisterSpanProcessor(ssp)

	// For the demonstration, use sdktrace.AlwaysSample sampler to sample all traces.
	// In a production application, use sdktrace.ProbabilitySampler with a desired probability.
	sdktrace.ApplyConfig(sdktrace.Config{DefaultSampler: sdktrace.AlwaysSample()})
}

func main() {
	initTracer()

	apitrace.GlobalTracer().WithSpan(context.Background(), "foo",
		func(ctx context.Context) error {
			apitrace.GlobalTracer().WithSpan(ctx, "bar",
				func(ctx context.Context) error {
					apitrace.GlobalTracer().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.

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
Tracing API Alpha October 28 2019
Tracing SDK Alpha October 28 2019
Metrics API Alpha October 28 2019
Metrics SDK Alpha October 28 2019
Zipkin Trace Exporter Alpha Unknown
Jaeger Trace Exporter Alpha October 28 2019
Prometheus Metrics Exporter Alpha October 28 2019
Trace Context Propagation Alpha Unknown
OpenTracing Bridge Alpha October
OpenCensus Bridge Alpha Unknown

Directories

Path Synopsis
api
core
This package provides basic types used in OpenTelemetry - keys, values, numbers and span contexts.
This package provides basic types used in OpenTelemetry - keys, values, numbers and span contexts.
key
This package provides convenience functions for creating keys and key-value pairs.
This package provides convenience functions for creating keys and key-value pairs.
metric
metric package provides an API for reporting diagnostic measurements using three basic kinds of instruments (or four, if calling one special case a separate one).
metric package provides an API for reporting diagnostic measurements using three basic kinds of instruments (or four, if calling one special case a separate one).
propagation
Package propagation contains interface definition for Binary and TextFormat propagators.
Package propagation contains interface definition for Binary and TextFormat propagators.
bridge
opentracing
This package implements a bridge that forwards OpenTracing API calls to the OpenTelemetry SDK.
This package implements a bridge that forwards OpenTracing API calls to the OpenTelemetry SDK.
opentracing/migration
This package provides interfaces and functions that are useful for providing a cooperation of the OpenTelemetry tracers with the OpenTracing API.
This package provides interfaces and functions that are useful for providing a cooperation of the OpenTelemetry tracers with the OpenTracing API.
build-tools module
checkdoc Module
multimod Module
semconvgen Module
collector module
cmd/builder Module
cmd/checkdoc Module
cmd/mdatagen Module
cmd/schemagen Module
model Module
contrib module
detectors/aws Module
detectors/gcp Module
propagators Module
tools Module
zpages Module
example
namedtracer Module
exporter
trace/stdout
Package stdout contains an OpenTelemetry tracing exporter for writing to stdout.
Package stdout contains an OpenTelemetry tracing exporter for writing to stdout.
trace/jaeger Module
otel module
example/basic Module
example/fib Module
example/grpc Module
example/http Module
metric Module
oteltest Module
sdk Module
sdk/metric Module
trace Module
plugin
othttp
Package othttp provides a http.Handler and functions that are intended to be used to add tracing by wrapping existing handlers (with Handler) and routes WithRouteTag.
Package othttp provides a http.Handler and functions that are intended to be used to add tracing by wrapping existing handlers (with Handler) and routes WithRouteTag.
Package propagation contains propagators for different format and carriers.
Package propagation contains propagators for different format and carriers.
proto
otlp Module
sdk
Package opentelemetry contains Go support for OpenTelemetry.
Package opentelemetry contains Go support for OpenTelemetry.
metric
Package metric implements the OpenTelemetry `Meter` API.
Package metric implements the OpenTelemetry `Meter` API.
trace
Package trace contains support for OpenTelemetry distributed tracing.
Package trace contains support for OpenTelemetry distributed tracing.
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL