quick-start.md

OpenTracing quick-start materials

Hello World examples

Both of these examples assume that Jaeger is running locally via Docker:

$ docker run -d -p 5775:5775/udp -p 16686:16686 jaegertracing/all-in-one:latest

These can be adapted to use Zipkin or any other OpenTracing-compatible Tracer easily by adjusting the initialization code to match the particular implementation.

Java

import com.uber.jaeger.Configuration;
import io.opentracing.Span;
import io.opentracing.util.GlobalTracer;

...

GlobalTracer.register(
    new Configuration(
        "your_service_name",
        new Configuration.SamplerConfiguration("const", 1),
        new Configuration.ReporterConfiguration(
            false, "localhost", null, 1000, 10000)
    ).getTracer());

...

try (Span parent = GlobalTracer.get()
            .buildSpan("hello")
            .start()) {
    try (Span child = GlobalTracer.get()
            .buildSpan("world")
            .asChildOf(parent)
            .start()) {
    }
}

Go

import (
    "github.com/opentracing/opentracing-go"
    "github.com/uber/jaeger-client-go"
    "github.com/uber/jaeger-client-go/config"
)

...

func main() {
    ...
    cfg := config.Configuration{
	Sampler: &config.SamplerConfig{
	    Type:  "const",
	    Param: 1,
	},
	Reporter: &config.ReporterConfig{
	    LogSpans:            true,
	    BufferFlushInterval: 1 * time.Second,
	},
    }
    tracer, closer, err := cfg.New(
        "your_service_name",
        config.Logger(jaeger.StdLogger),
    )
    opentracing.SetGlobalTracer(tracer)
    defer closer.Close()

    someFunction()
    ...
}

...

func someFunction() {
    parent := opentracing.GlobalTracer().StartSpan("hello")
    defer parent.Finish()
    child := opentracing.GlobalTracer().StartSpan(
	"world", opentracing.ChildOf(parent.Context()))
    defer child.Finish()
}

Self-Guided Walkthrough Tutorials

Go: Take OpenTracing for a HotROD Ride involves successive optimizations of a Go-based Ride-on-Demand demonstration service, all informed by tracing data.

Java: MicroDonuts shows the reader how to get tracing instrumentation added to a multi-service app, and includes properly-configured initialization of several OpenTracing-compatible Tracers.

Multiple languages (Go, Java, Python, Node.js): OpenTracing Tutorial