1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-04 09:43:23 +02:00
OpenTelemetry Go API and SDK https://opentelemetry.io/
Go to file
2020-07-10 10:28:45 -04:00
.circleci Bump CircleCI instance size (#917) 2020-07-07 10:35:37 -07:00
.github Allow changes to go.sum *and* go.mod when running dependabot tidy-up (#871) 2020-06-24 13:35:14 -07:00
api Add semantic conventions for OS process as resource attributes (#919) 2020-07-09 15:02:03 -07:00
bridge/opentracing Update Tracer API with instrumentation version (#802) 2020-06-09 11:47:54 -07:00
example Bump google.golang.org/api from 0.28.0 to 0.29.0 in /exporters/trace/jaeger (#925) 2020-07-09 12:09:18 -07:00
exporters [jaeger] Added WithBatchMaxCount as an option (#931) 2020-07-10 10:28:45 -04:00
instrumentation Update grpctrace instrumentation span names (#922) 2020-07-09 13:12:00 -07:00
internal Avoid setting span status to Unknown when no HTTP status is provided; stdlib assumes it to be 200 OK (#908) 2020-07-07 09:00:21 -07:00
sdk Fix incorrect aggregation; Prometheus exporter behavior (#903) 2020-07-07 12:52:35 -07:00
tools Bump github.com/itchyny/gojq from 0.10.4 to 0.11.0 in /tools (#926) 2020-07-09 10:26:53 -07:00
.gitignore Merge otlp collector examples (#841) 2020-06-23 08:37:07 -07:00
.golangci.yml Remove nolint and update misspell to ignore cancelled 2020-05-29 11:11:19 -07:00
CHANGELOG.md Add semantic conventions for OS process as resource attributes (#919) 2020-07-09 15:02:03 -07:00
CODEOWNERS Remove krnowak from approvers 2020-05-15 18:18:00 +02:00
CONTRIBUTING.md Ask for changelog updates with PRs (#879) 2020-06-26 17:50:19 -07:00
doc.go Alias api/global types, functions to root 2020-05-03 16:01:15 +08:00
get_main_pkgs.sh Update License header for all source files (#586) 2020-03-23 22:41:10 -07:00
go.mod Fix incorrect aggregation; Prometheus exporter behavior (#903) 2020-07-07 12:52:35 -07:00
go.sum Fix incorrect aggregation; Prometheus exporter behavior (#903) 2020-07-07 12:52:35 -07:00
LICENSE
Makefile Remove -v from Go tests (#904) 2020-07-06 11:41:12 -04:00
otel.go rm api/global alias functions 2020-05-07 00:41:11 +08:00
pre_release.sh fix pre_release.sh to update version in sdk/opentelemetry.go (#607) 2020-03-31 12:02:56 -07:00
README.md added readme section to point to contrib repo (#612) 2020-04-02 10:58:09 -07:00
RELEASING.md Clean up tools (#762) 2020-05-26 11:35:34 -07:00
tag.sh update tag.sh to create signed tags. (#604) 2020-03-30 20:53:10 -07:00
verify_examples.sh Clean up tools (#762) 2020-05-26 11:35:34 -07:00

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