Jaeger - a Distributed Tracing System
Jaeger, inspired by Dapper and OpenZipkin, is a distributed tracing platform created by Uber Technologies and donated to Cloud Native Computing Foundation. It can be used for monitoring microservices-based distributed systems:
- Distributed context propagation
- Distributed transaction monitoring
- Root cause analysis
- Service dependency analysis
- Performance / latency optimization
- Jaeger documentation for getting started, operational details, and other information.
- Blog post Evolving Distributed Tracing at Uber.
- Tutorial / walkthrough Take OpenTracing for a HotROD ride.
Jaeger is hosted by the Cloud Native Computing Foundation (CNCF) as the 7th top-level project (graduated in October 2019). If you are a company that wants to help shape the evolution of technologies that are container-packaged, dynamically-scheduled and microservices-oriented, consider joining the CNCF. For details about who's involved and how Jaeger plays a role, read the CNCF Jaeger incubation announcement and Jaeger graduation announcement.
Jaeger is an open source project with open governance. We welcome contributions from the community, and we’d love your help to improve and extend the project. Here are some ideas for how to get involved. Many of them don’t even require any coding.
Jaeger backend is designed to have no single points of failure and to scale with the business needs. For example, any given Jaeger installation at Uber is typically processing several billions of spans per day.
Native support for OpenTracing
Jaeger backend, Web UI, and instrumentation libraries have been designed from the ground up to support the OpenTracing standard.
- Represent traces as directed acyclic graphs (not just trees) via span references
- Support strongly typed span tags and structured logs
- Support general distributed context propagation mechanism via baggage
On 28-May-2019, the OpenTracing and OpenCensus projects announced their intention to merge into a new CNCF project called OpenTelemetry. The Jaeger and OpenTelemetry projects have different goals. OpenTelemetry aims to provide APIs and SDKs in multiple languages to allow applications to export various telemetry data out of the process, to any number of metrics and tracing backends. The Jaeger project is primarily the tracing backend that receives tracing telemetry data and provides processing, aggregation, data mining, and visualizations of that data. The Jaeger client libraries do overlap with OpenTelemetry in functionality. OpenTelemetry will natively support Jaeger as a tracing backend and eventually might make Jaeger native clients unnecessary. For more information please refer to a blog post Jaeger and OpenTelemetry.
Multiple storage backends
Jaeger supports two popular open source NoSQL databases as trace storage backends: Cassandra and Elasticsearch. There is also embedded database support using Badger. There are ongoing community experiments using other databases, such as ScyllaDB, InfluxDB, Amazon DynamoDB. Jaeger also ships with a simple in-memory storage for testing setups.
Modern Web UI
Cloud Native Deployment
Jaeger backend is distributed as a collection of Docker images. The binaries support various configuration methods, including command line options, environment variables, and configuration files in multiple formats (yaml, toml, etc.) Deployment to Kubernetes clusters is assisted by Kubernetes templates and a Helm chart.
Backwards compatibility with Zipkin
Although we recommend instrumenting applications with OpenTracing API and binding to Jaeger client libraries to benefit from advanced features not available elsewhere, if your organization has already invested in the instrumentation using Zipkin libraries, you do not have to rewrite all that code. Jaeger provides backwards compatibility with Zipkin by accepting spans in Zipkin formats (Thrift or JSON v1/v2) over HTTP. Switching from Zipkin backend is just a matter of routing the traffic from Zipkin libraries to the Jaeger backend.
Version Compatibility Guarantees
Occasionally, CLI flags can be deprecated due to, for example, usability improvements or new functionality. In such situations, developers introducing the deprecation are required to follow these guidelines.
In short, for a deprecated CLI flag, you should expect to see the following message in the
(deprecated, will be removed after yyyy-mm-dd or in release vX.Y.Z, whichever is later)
A grace period of at least 3 months or two minor version bumps (whichever is later) from the first release containing the deprecation notice will be provided before the deprecated CLI flag can be deleted.
For example, consider a scenario where v1.28.0 is released on 01-Jun-2021 containing a deprecation notice for a CLI flag. This flag will remain in a deprecated state until the later of 01-Sep-2021 or v1.30.0 where it can be removed on or after either of those events. It may remain deprecated for longer than the aforementioned grace period.
- Published: https://www.jaegertracing.io/docs/
- Source: https://github.com/jaegertracing/documentation
Building From Source
Thanks to all the people who already contributed!
Rules for becoming a maintainer are defined in the GOVERNANCE document.
Below are the official maintainers of the Jaeger project.
@jaegertracing/jaeger-maintainers to tag them on issues / PRs.
Some repositories under jaegertracing org have additional maintainers.
We are grateful to our former maintainers for their contributions to the Jaeger project.
Project Status Bi-Weekly Meeting
The Jaeger contributors meet bi-weekly, and everyone is welcome to join. Agenda and meeting details here.
Get in Touch
Have questions, suggestions, bug reports? Reach the project community via these channels:
- Slack chat room
#jaeger(need to join CNCF Slack for the first time)
- GitHub issues and discussions
Jaeger as a product consists of multiple components. We want to support different types of users, whether they are only using our instrumentation libraries or full end to end Jaeger installation, whether it runs in production or you use it to troubleshoot issues in development.
Package flags defines command line flags that are shared by several jaeger components.
|Package flags defines command line flags that are shared by several jaeger components.|
Package ui installs UI assets packaged with github.com/rakyll/statik.
|Package ui installs UI assets packaged with github.com/rakyll/statik.|
Package assets contains auto-generated UI asset files created during the build.
|Package assets contains auto-generated UI asset files created during the build.|
Package model describes the internal data model for Trace and Span
|Package model describes the internal data model for Trace and Span|
Package adjuster contains various adjusters for model.Trace.
|Package adjuster contains various adjusters for model.Trace.|
Package converter contains various utilities for converting model.Trace to/from other data modes, like Thrift, or UI JSON.
|Package converter contains various utilities for converting model.Trace to/from other data modes, like Thrift, or UI JSON.|
Package json allows converting model.Trace to external JSON data model.
|Package json allows converting model.Trace to external JSON data model.|
Package thrift allows converting model.Trace to/from various thrift models.
|Package thrift allows converting model.Trace to/from various thrift models.|
Package jaeger allows converting model.Trace to/from jaeger.thrift model.
|Package jaeger allows converting model.Trace to/from jaeger.thrift model.|
Package zipkin allows converting model.Trace to/from zipkin.thrift model.
|Package zipkin allows converting model.Trace to/from zipkin.thrift model.|
Package json defines the external JSON representation for Jaeger traces.
|Package json defines the external JSON representation for Jaeger traces.|
Package pkg is the collection of utility packages used by the Jaeger components without being specific to its internals.
|Package pkg is the collection of utility packages used by the Jaeger components without being specific to its internals.|
Package metrics provides command line flags for configuring the metrics backend.
|Package metrics provides command line flags for configuring the metrics backend.|
Package plugin is the collection of implementations of different interfaces defined across Jaeger For example, implementations of the storage interface can be found in the plugin package
|Package plugin is the collection of implementations of different interfaces defined across Jaeger For example, implementations of the storage interface can be found in the plugin package|
Package api_v3 is a reverse proxy.
|Package api_v3 is a reverse proxy.|
Package storage is the collection of different storage interfaces that are shared by two or more components.
|Package storage is the collection of different storage interfaces that are shared by two or more components.|
Package restapi Zipkin API Zipkin's v2 api currently includes a POST endpoint that can receive spans.
|Package restapi Zipkin API Zipkin's v2 api currently includes a POST endpoint that can receive spans.|