Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Zipkin is a distributed tracing system
Java Scala JavaScript Thrift HTML CSS

Merge pull request #542 from openzipkin/adrian.update-docs

Fixes copyright, release and links in docs
latest commit 25acb4ed48
@adriancole adriancole authored
Failed to load latest commit information.
bin Removes SBT
doc Fixes copyright, release and links in docs
gradle Migrate build system to Gradle
zipkin-aggregate Transitive reduction on inter-project dependencies
zipkin-anormdb Transitive reduction on inter-project dependencies
zipkin-cassandra Removes SBT
zipkin-collector-core Transitive reduction on inter-project dependencies
zipkin-collector-scribe Transitive reduction on inter-project dependencies
zipkin-collector-service Bundles scala config of collector and query services
zipkin-collector Transitive reduction on inter-project dependencies
zipkin-common Removes SBT
zipkin-example Transitive reduction on inter-project dependencies
zipkin-query-core Transitive reduction on inter-project dependencies
zipkin-query-service Bundles scala config of collector and query services
zipkin-query Transitive reduction on inter-project dependencies
zipkin-receiver-kafka Transitive reduction on inter-project dependencies
zipkin-receiver-scribe Transitive reduction on inter-project dependencies
zipkin-redis-example Transitive reduction on inter-project dependencies
zipkin-redis Transitive reduction on inter-project dependencies
zipkin-sampler Removes SBT
zipkin-scrooge Removes SBT
zipkin-thrift Removes SBT
zipkin-tracegen Removes SBT
zipkin-web Transitive reduction on inter-project dependencies
zipkin-zookeeper Removes SBT
.gitignore Removes SBT
.mailmap Moar mailmap
.travis.yml Back to new build infra on Travis
CHANGELOG Moves zipkin-hbase to its own repository
CONTRIBUTING.md move everything to top level
CONTRIBUTORS.md move everything to top level
LICENSE move everything to top level
NOTICE move everything to top level
README.md Documents how to get started with SQLite
build.gradle Add gradle idea plugin
gradle.properties Uses Gradle daemon to assign memory args
gradlew Migrate build system to Gradle
gradlew.bat Migrate build system to Gradle
settings.gradle settings.gradle: Merge include statements into a single one

README.md

Gitter chat Build Status

Zipkin (doc/zipkin-logo-200x119.jpg)

Zipkin is a distributed tracing system. It is used by Twitter to help gather timing data for all their disparate services. The front end is a "waterfall" style graph of service calls showing call durations as horizontal bars:

Screenshot

Running Zipkin

Zipkin is a collection of processes (a backend for the data, a "collector", and query engine, and a web UI) and all of them need to be running to make any progress:

Architecture

If you are familiar with Docker, the quickest way to get started quickly is to use the Docker Zipkin project, which (in addition to being able to build docker images) provides scripts and a docker-compose.yml for launching pre-built images, e.g.

$ git clone https://github.com/openzipkin/docker-zipkin
$ cd docker-zipkin/deploy
$ docker-compose up

If you are happy building from source you can use the scripts in the [bin/] directory of this repository.

Here's how to start zipkin using the default file-based backend and view traces.

# get the zipkin source and change to its directory
$ git clone https://github.com/openzipkin/zipkin; cd zipkin
# start the collector server in a new terminal session or tab
$ ./bin/collector
# start the query server in a new terminal session or tab
$ ./bin/query
# start the web server in a new terminal session or tab
$ ./bin/web
# create dummy traces
$ ./bin/tracegen
# open the ui and look at them!
$ open http://localhost:8080/

Full documentation

See http://twitter.github.com/zipkin

Get involved

Join the openzipkin/zipkin gitter chat for questions and to talk with the developers. Otherwise, there are two mailing lists you can use to get in touch with other users and developers.

Users: https://groups.google.com/group/zipkin-user

Developers: https://groups.google.com/group/zipkin-dev

Issues

Noticed a bug? Please file an issue

Contributing

See CONTRIBUTING.md for guidelines.

Areas where we'd love to see contributions:

  • adding tracing to more libraries and protocols
  • interesting reports generated with Hadoop from the trace data
  • extending collector to support more transports and storage systems
  • trace data visualizations in the web UI
Something went wrong with that request. Please try again.