1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-10 09:50:58 +02:00
OpenTelemetry Go API and SDK https://opentelemetry.io/
Go to file
Isobel Redelmeier 3a9c80c56f Provide conformance tests for tracers (#191)
* Provide conformance tests for tracers

The test harness may be used to ensure that a given tracer behaves
according to the expectations set by the API.

* Add `ToMatchError` matcher

* Use DeepEqual to compare unknown types in matchers

Unlike basic `==`/`!=`, `reflect.DeepEqual` can compare arbitrary
types (e.g., `[]string` to `[]string`)

* Use struct instead of string for test context key
2019-10-17 11:13:57 -07:00
.circleci Add Circle ci (#41) 2019-07-02 16:21:24 -07:00
api Provide conformance tests for tracers (#191) 2019-10-17 11:13:57 -07:00
example add RegisterSimpleSpanProcessor() modeled on stackdriver code (#213) 2019-10-16 15:13:39 -07:00
experimental change key to a string alias and KeyValue constructors (#217) 2019-10-16 22:49:58 -07:00
exporter/trace exporter(jaeger): change jaeger process tags to core.KeyValue (#219) 2019-10-17 09:59:30 -07:00
internal Provide conformance tests for tracers (#191) 2019-10-17 11:13:57 -07:00
plugin change key to a string alias and KeyValue constructors (#217) 2019-10-16 22:49:58 -07:00
propagation Enable golint & gofmt, resolve issues (#214) 2019-10-16 10:24:38 -07:00
sdk Provide conformance tests for tracers (#191) 2019-10-17 11:13:57 -07:00
.gitignore Remove experimental/streaming globals, add streaming example (#135) 2019-09-23 14:39:10 -07:00
.golangci.yml Enable golint & gofmt, resolve issues (#214) 2019-10-16 10:24:38 -07:00
CODEOWNERS Add jmacd as a code owner (#42) 2019-07-02 14:03:36 -07:00
CONTRIBUTING.md Add some docs about useful step before filing a PR (#151) 2019-10-01 09:16:45 -07:00
go.mod Bump golangci-lint to v1.21.0 (#215) 2019-10-16 10:05:15 -07:00
go.sum Bump golangci-lint to v1.21.0 (#215) 2019-10-16 10:05:15 -07:00
LICENSE Initial commit 2019-05-16 12:05:27 -07:00
Makefile Add some docs about useful step before filing a PR (#151) 2019-10-01 09:16:45 -07:00
README.md update the schedule. (#204) 2019-10-14 14:42:01 -07:00
tools.go Run go generate during make and make sure that generated files are in sync in CI (#101) 2019-08-22 11:16:51 -07:00

OpenTelemetry-Go

Circle CI Docs Go Report Card

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 release isn't guaranteed to conform to a specific version of the specification, and future releases will not attempt to maintain backwards 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

Experimental streaming SDK

The experimental/streaming directory contains an experimental SDK that supports a low-level exporter.

go run experimental/streaming/example/basic/main.go