Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 67 lines (41 sloc) 2.674 kb
84ffd64 @johanoskarsson Add logo and brush up contribute seconds
johanoskarsson authored
1 ![Zipkin (doc/zipkin-logo-200x119.jpg)](https://github.com/twitter/zipkin/raw/master/doc/zipkin-logo-200x119.jpg)
2
a9c0695 Slim down README.md
Franklin Hu authored
3 [Zipkin](http://twitter.github.com/zipkin) is a distributed tracing system that helps us gather timing data for all the disparate services at Twitter.
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
4
a9c0695 Slim down README.md
Franklin Hu authored
5 ## Full documentation
6 See [http://twitter.github.com/zipkin](http://twitter.github.com/zipkin)
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
7
a9c0695 Slim down README.md
Franklin Hu authored
8 ## Quick start
9 You'll need Scala 2.9.1
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
10
a9c0695 Slim down README.md
Franklin Hu authored
11 Clone the repo, `git clone git://github.com/twitter/zipkin`, or [download a release](https://github.com/twitter/zipkin/downloads)
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
12
a9c0695 Slim down README.md
Franklin Hu authored
13 To run a collector daemon: `bin/collector`
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
14
a9c0695 Slim down README.md
Franklin Hu authored
15 To run a query daemon: `bin/query`
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
16
a9c0695 Slim down README.md
Franklin Hu authored
17 To run a UI daemon: `bin/ui`
5c7fbb9 @johanoskarsson Added a section to the readme describing how to instrument a library
johanoskarsson authored
18
a9c0695 Slim down README.md
Franklin Hu authored
19 For a more in-depth installation guide, see: [http://twitter.github.com/zipkin/install.html](http://twitter.github.com/zipkin/install.html)
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
20
21 ## Mailing lists
22 There are two mailing lists you can use to get in touch with other users and developers.
23
a9c0695 Slim down README.md
Franklin Hu authored
24 Users: [https://groups.google.com/group/zipkin-user](https://groups.google.com/group/zipkin-user)
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
25
a9c0695 Slim down README.md
Franklin Hu authored
26 Developers: [https://groups.google.com/group/zipkin-dev](https://groups.google.com/group/zipkin-dev)
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
27
28 ## Issues
a9c0695 Slim down README.md
Franklin Hu authored
29 Noticed a bug? [https://github.com/twitter/zipkin/issues](https://github.com/twitter/zipkin/issues)
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
30
31 ## Contributions
32 Contributions are very welcome! Please create a pull request on github and we'll look at it as soon as possible.
33
34 Try to make the code in the pull request as focused and clean as possible, stick as close to our code style as you can.
35
36 If the pull request is becoming too big we ask that you split it into smaller ones.
37
1f72e8d s/ui/UI/
Franklin Hu authored
38 Areas where we'd love to see contributions include: 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 and other ways of visualizing the data in the web UI.
84ffd64 @johanoskarsson Add logo and brush up contribute seconds
johanoskarsson authored
39
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
40 ## Versioning
a9c0695 Slim down README.md
Franklin Hu authored
41 We use [SemVer](http://semver.org/) style versioning.
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
42
43 ## Authors
44 Thanks to everyone below for making Zipkin happen!
45
46 Zipkin server
a9c0695 Slim down README.md
Franklin Hu authored
47
48 * Johan Oskarsson: [@skr](https://twitter.com/skr)
49 * Franklin Hu: [@thisisfranklin](https://twitter.com/thisisfranklin)
50 * Ian Ownbey: [@iano](https://twitter.com/iano)
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
51
52 Zipkin UI
a9c0695 Slim down README.md
Franklin Hu authored
53
54 * Franklin Hu: [@thisisfranklin](https://twitter.com/thisisfranklin)
55 * Bill Couch: [@couch](https://twitter.com/couch)
56 * David McLaughlin: [@dmcg](https://twitter.com/dmcg)
57 * Chad Rosen: [@zed](https://twitter.com/zed)
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
58
59 Instrumentation
a9c0695 Slim down README.md
Franklin Hu authored
60
61 * Marius Eriksen: [@marius](https://twitter.com/marius)
62 * Arya Asemanfar: [@a_a](https://twitter.com/a_a)
2b7acea @johanoskarsson Initial commit
johanoskarsson authored
63
64 ## License
65 Copyright 2012 Twitter, Inc.
66
a9c0695 Slim down README.md
Franklin Hu authored
67 Licensed under the Apache License, Version 2.0: [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Something went wrong with that request. Please try again.