jaeger

package module
v1.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 19, 2018 License: Apache-2.0 Imports: 0 Imported by: 0

README

Build Status Coverage Status Gitter chat OpenTracing-1.0 FOSSA Status CII Best Practices

Jaeger - a Distributed Tracing System

Jaeger, inspired by Dapper and OpenZipkin, is a distributed tracing system released as open source by Uber Technologies. 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

See also:

Jaeger is hosted by the Cloud Native Computing Foundation (CNCF). 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 announcement.

Features

High Scalability

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 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
Multiple storage backends

Jaeger supports two popular open source NoSQL databases as trace storage backends: Cassandra 3.4+ and Elasticsearch 5.x/6.x. 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

Jaeger Web UI is implemented in Javascript using popular open source frameworks like React. Several performance improvements have been released in v1.0 to allow the UI to efficiently deal with large volumes of data, and to display traces with tens of thousands of spans (e.g. we tried a trace with 80,000 spans).

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.

Observability

All Jaeger backend components expose Prometheus metrics by default (other metrics backends are also supported). Logs are written to standard out using the structured logging library zap.

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.

Documentation
Instrumentation Libraries
Deployment
Components

Building From Source

See CONTRIBUTING.

Contributing

See CONTRIBUTING.

Maintainers

Below are the official maintainers of the Jaeger project. Please use @jaegertracing/jaeger-maintainers to tag them on issues / PRs.

  • @black-adder
  • @jpkrohling
  • @pavolloffay
  • @vprithvi
  • @yurishkuro

Some repositories under jaegertracing org have additional maintainers.

Project Status Bi-Weekly Meeting

The Jaeger contributors meet bi-weekly, and everyone is welcome to join. Agenda and meeting details here.

Roadmap

See https://www.jaegertracing.io/docs/roadmap/

Questions, Discussions, Bug Reports

Reach project contributors via these channels:

Adopters

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.

Please see ADOPTERS.md for some of the organizations using Jaeger today. If you would like to add your organization to the list, please comment on our survey issue.

License

Apache 2.0 License.

Documentation

Overview

Package jaeger contains the code for Jaeger backend.

Directories

Path Synopsis
cmd
builder
Package builder defines builder resources (like logger and metrics) shared by jaeger components They are defined in this shared location so that if several components are wired into a single binary (e.g.
Package builder defines builder resources (like logger and metrics) shared by jaeger components They are defined in this shared location so that if several components are wired into a single binary (e.g.
env
flags
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.
query/app/ui
Package ui installs UI assets packaged with github.com/rakyll/statik.
Package ui installs UI assets packaged with github.com/rakyll/statik.
query/app/ui/actual/statik
Package statik is reserved for code generated by statik
Package statik is reserved for code generated by statik
query/app/ui/placeholder/statik
Package statik is a placeholder for UI assets packaged with github.com/rakyll/statik.
Package statik is a placeholder for UI assets packaged with github.com/rakyll/statik.
examples
hotrod/services/driver/thrift-gen/driver
Package driver is generated code used to make or handle TChannel calls using Thrift.
Package driver is generated code used to make or handle TChannel calls using Thrift.
Package model describes the internal data model for Trace and Span Package model is a generated protocol buffer package.
Package model describes the internal data model for Trace and Span Package model is a generated protocol buffer package.
adjuster
Package adjuster contains various adjusters for model.Trace.
Package adjuster contains various adjusters for model.Trace.
converter
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.
converter/json
Package json allows converting model.Trace to external JSON data model.
Package json allows converting model.Trace to external JSON data model.
converter/thrift
Package thrift allows converting model.Trace to/from various thrift models.
Package thrift allows converting model.Trace to/from various thrift models.
converter/thrift/jaeger
Package jaeger allows converting model.Trace to/from jaeger.thrift model.
Package jaeger allows converting model.Trace to/from jaeger.thrift model.
converter/thrift/zipkin
Package zipkin allows converting model.Trace to/from zipkin.thrift model.
Package zipkin allows converting model.Trace to/from zipkin.thrift model.
json
Package json defines the external JSON representation for Jaeger traces.
Package json defines the external JSON representation for Jaeger traces.
prototest
Package prototest is a generated protocol buffer package.
Package prototest is a generated protocol buffer package.
pkg
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.
es
metrics
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 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.
swagger-gen
restapi
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.
thrift-gen
baggage
Package baggage is generated code used to make or handle TChannel calls using Thrift.
Package baggage is generated code used to make or handle TChannel calls using Thrift.
jaeger
Package jaeger is generated code used to make or handle TChannel calls using Thrift.
Package jaeger is generated code used to make or handle TChannel calls using Thrift.
sampling
Package sampling is generated code used to make or handle TChannel calls using Thrift.
Package sampling is generated code used to make or handle TChannel calls using Thrift.
zipkincore
Package zipkincore is generated code used to make or handle TChannel calls using Thrift.
Package zipkincore is generated code used to make or handle TChannel calls using Thrift.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL