Ukraine flag We stand with our friends and colleagues in Ukraine. To support Ukraine in their time of need visit this page.

Getting started

Get up and running with Jaeger in your local environment

Version  1.6 Go to the latest 1.x version Go to the latest 2.x version

Instrumentation

Your applications must be instrumented before they can send tracing data to Jaeger backend. Check the Client Libraries section for information about how to use the OpenTracing API and how to initialize and configure Jaeger tracers.

All in one Docker image

This image, designed for quick local testing, launches the Jaeger UI, collector, query, and agent, with an in memory storage component.

The simplest way to start the all in one docker image is to use the pre-built image published to DockerHub (a single command line).

$ docker run -d --name jaeger \
  -e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \
  -p 5775:5775/udp \
  -p 6831:6831/udp \
  -p 6832:6832/udp \
  -p 5778:5778 \
  -p 16686:16686 \
  -p 14268:14268 \
  -p 9411:9411 \
  jaegertracing/all-in-one:1.6.0

You can then navigate to http://localhost:16686 to access the Jaeger UI.

The container exposes the following ports:

PortProtocolComponentFunction
5775UDPagentaccept zipkin.thrift over compact thrift protocol
6831UDPagentaccept jaeger.thrift over compact thrift protocol
6832UDPagentaccept jaeger.thrift over binary thrift protocol
5778HTTPagentserve configs
16686HTTPqueryserve frontend
14268HTTPcollectoraccept jaeger.thrift directly from clients
9411HTTPcollectorZipkin compatible endpoint

Kubernetes and OpenShift

Kubernetes and OpenShift templates can be found in the Jaegertracing external link organization on Github.

Sample Application

HotROD (Rides on Demand)

This is a demo application that consists of several microservices and illustrates the use of the OpenTracing API external link. A tutorial / walkthrough is available in the blog post: Take OpenTracing for a HotROD ride external link.

It can be run standalone, but requires Jaeger backend to view the traces.

Running

From Source
mkdir -p $GOPATH/src/github.com/jaegertracing
cd $GOPATH/src/github.com/jaegertracing
git clone git@github.com:jaegertracing/jaeger.git jaeger
cd jaeger
make install
cd examples/hotrod
go run ./main.go all
From docker
$ docker run --rm -it \
  --link jaeger \
  -p8080-8083:8080-8083 \
  jaegertracing/example-hotrod:1.6.0 \
  --jaeger-agent.host-port=jaeger:6831 \
  all

Then navigate to http://localhost:8080.

Features

  • Discover architecture of the whole system via data-driven dependency diagram.

  • View request timeline and errors; understand how the app works.

  • Find sources of latency and lack of concurrency.

  • Highly contextualized logging.

  • Use baggage propagation to:

    • Diagnose inter-request contention (queueing).
    • Attribute time spent in a service.

  • Use open source libraries with OpenTracing integration to get vendor-neutral instrumentation for free.

Prerequisites

Client Libraries

Look here.

Running Individual Jaeger Components

Individual Jaeger backend components can be run from source. They all have their main.go in the cmd folder. For example, to run the jaeger-agent:

mkdir -p $GOPATH/src/github.com/jaegertracing
cd $GOPATH/src/github.com/jaegertracing
git clone git@github.com:jaegertracing/jaeger.git jaeger
cd jaeger
make install
go run ./cmd/agent/main.go

Migrating from Zipkin

Collector service exposes Zipkin compatible REST API /api/v1/spans and /api/v2/spans for both JSON and thrift encoding. By default it’s disabled. It can be enabled with --collector.zipkin.http-port=9411.

Zipkin Thrift IDL file can be found in jaegertracing/jaeger-idl external link. It’s compatible with openzipkin/zipkin-api external link