otel

package module
Version: v0.5.0 Latest Latest
Warning

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

Go to latest
Published: May 14, 2020 License: Apache-2.0 Imports: 3 Imported by: 1,216

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.

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.

Compatible Libraries

See the opentelemetry-go-contrib repo for packages that facilitates instrumenting other useful Go libraries with opentelemetry-go for distributed tracing and monitoring.

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 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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Meter

type Meter = metric.Meter

type Propagators

type Propagators = propagation.Propagators

type Tracer

type Tracer = trace.Tracer

Source Files

Directories

Path Synopsis
api
correlation
This package implements the correlation functionality as specified in the OpenTelemetry specification.
This package implements the correlation functionality as specified in the OpenTelemetry specification.
kv
package kv provides basic key and value types.
package kv provides basic key and value types.
metric
metric package provides an API for reporting diagnostic measurements using four basic kinds of instruments.
metric package provides an API for reporting diagnostic measurements using four basic kinds of instruments.
propagation
Package propagation contains interface definition for HTTP propagators.
Package propagation contains interface definition for HTTP 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.
opencensus Module
example
basic Module
fib Module
grpc Module
http Module
jaeger Module
namedtracer Module
opencensus Module
passthrough Module
prometheus Module
zipkin Module
exporter
trace/jaeger Module
exporters
trace/stdout
Package stdout contains an OpenTelemetry tracing exporter for writing to stdout.
Package stdout contains an OpenTelemetry tracing exporter for writing to stdout.
jaeger Module
otlp Module
prometheus Module
stdout Module
trace/jaeger Module
trace/zipkin Module
zipkin Module
metric module
oteltest 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.
othttp/filters
Package filters provides a set of filters useful with the othttp.WithFilter() option to control which inbound requests are traced.
Package filters provides a set of filters useful with the othttp.WithFilter() option to control which inbound requests are traced.
schema module
sdk
Package opentelemetry contains Go support for OpenTelemetry.
Package opentelemetry contains Go support for OpenTelemetry.
metric
Package metric implements the OpenTelemetry metric.Meter API.
Package metric implements the OpenTelemetry metric.Meter API.
resource
Package resource provides functionality for resource, which capture identifying information about the entities for which signals are exported.
Package resource provides functionality for resource, which capture identifying information about the entities for which signals are exported.
resource/resourcekeys
Package resourcekeys contains well known type and label keys for resources.
Package resourcekeys contains well known type and label keys for resources.
trace
Package trace contains support for OpenTelemetry distributed tracing.
Package trace contains support for OpenTelemetry distributed tracing.
trace module
internal
tools Module

Jump to

Keyboard shortcuts

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