Giter VIP home page Giter VIP logo

opentelemetry-go's Introduction

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 4 2019
Tracing SDK Alpha October 4 2019
Metrics API Alpha October 14 2019
Metrics SDK Alpha October 14 2019
Zipkin Trace Exporter Alpha Unknown
Jaeger Trace Exporter Alpha October 4 2019
Prometheus Metrics Exporter Alpha October 14 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

opentelemetry-go's People

Contributors

rghetia avatar thinkerou avatar krnowak avatar jmacd avatar iredelmeier avatar djosephsen avatar akvanhar avatar agneum avatar sergeykanzhelev avatar dmathieu avatar paivagustavo avatar zchee avatar ymotongpoo avatar lizthegrey avatar fuweid avatar stgrzeszczak avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.