edit

Deployment

The main Jaeger backend components are released as Docker images on Docker Hub:

Component Repository
jaeger-agent hub.docker.com/r/jaegertracing/jaeger-agent/
jaeger-collector hub.docker.com/r/jaegertracing/jaeger-collector/
jaeger-query hub.docker.com/r/jaegertracing/jaeger-query/

There are orchestration templates for running Jaeger with:

Agent

Jaeger client libraries expect jaeger-agent process to run locally on each host. The agent exposes the following ports:

Port Protocol Function
5775 UDP accept zipkin.thrift over compact thrift protocol
6831 UDP accept jaeger.thrift over compact thrift protocol
6832 UDP accept jaeger.thrift over binary thrift protocol
5778 HTTP serve configs, sampling strategies

Discovery System Integration

The agents can connect point to point to a single collector address, which could be load balanced by another infrastructure component (e.g. DNS) across multilpe collectors. The agent can also be configured with a static list of collector addresses.

In the future we will support different service discovery systems to dynamically load balance across several collectors (issue 213).

Collectors

Many instances of jaeger-collector can be run in parallel. Collectors require almost no configuration, except for the location of Cassandra cluster, via -cassandra.keyspace and -cassandra.servers options. To see all command line options run

go run ./cmd/collector/main.go -h

or, if you don't have the source code

docker run -it --rm jaegertracing/jaeger-collector /go/bin/collector-linux -h

At default settings the collector exposes the following ports:

Port Protocol Function
14267 TChannel used by jaeger-agent to send spans in jaeger.thrift format
14268 HTTP can accept spans directly from clients in Jaeger or Zipkin Thrift

Storage Backend

Collectors require a persistent storage backend. Cassandra 3.x is the primary supported storage. There is ongoing work to add support for Elasticsearch, MySQL, and ScyllaDB.

Cassandra

A script is provided to initialize Cassandra keyspace and schema using Cassandra's interactive shell cqlsh:

sh ./plugin/storage/cassandra/cassandra3v001-schema.sh test | cqlsh

For production deployment, pass prod {datacenter} arguments to the script, where {datacenter} is the name used in the Cassandra configuration.

The script accepts additional parameters as environment variables:

  • TTL - default time to live for all data, in seconds (default: 172800, 2 days)
  • KEYSPACE - keyspace (default: jaeger_v1_{datacenter})
  • REPLICATION_FACTOR - replication factor for prod (default: 2)

Query Service & UI

jaeger-query serves the API endpoints and a React/Javascript UI. The service is stateless and is typically run behind a load balancer, e.g. nginx.

At default settings the query service exposes the following port(s):

Port Protocol Function
16686 HTTP /api/* endpoints and Jaeger UI at /

TODO: Swagger and GraphQL API (issue 158).

Aggregation Jobs for Service Dependencies

At the moment this is work in progress. We're working on a post-processing data pipeline that will include aggregating data to present service dependency diagram.