Merge pull request #35 from openzipkin/bounded-spans
Adds advice about bounding spans
diff --git a/_data/existing_instrumentations.yml b/_data/existing_instrumentations.yml
index 6d76da3..6cfc8a5 100644
--- a/_data/existing_instrumentations.yml
+++ b/_data/existing_instrumentations.yml
@@ -2,10 +2,10 @@
library: >-
[zipkin-js](https://github.com/openzipkin/zipkin-js)
framework: >-
- [cujoJS](http://cujojs.com), [express](http://expressjs.com/)
+ [cujoJS](http://cujojs.com), [express](http://expressjs.com/), [restify](http://restify.com/)
propagation: Http (B3)
transports: >-
- [Kafka \\| Scribe](https://github.com/openzipkin/zipkin-js#transports)
+ [Http \\| Kafka \\| Scribe](https://github.com/openzipkin/zipkin-js#transports)
sampling: >-
Yes
notes: >-
@@ -34,16 +34,35 @@
- language: Java
library: >-
+ [htrace](https://github.com/apache/incubator-htrace/tree/master/htrace-zipkin)
+ framework: HDFS, HBase
+ propagation:
+ transports: Http, Scribe
+ sampling: "Yes"
+ notes: Java 7 or higher
+
+- language: Java
+ library: >-
[Spring Cloud Sleuth](https://github.com/spring-cloud/spring-cloud-sleuth)
framework: Spring, Spring Cloud (e.g. Stream, Netflix)
propagation: Http (B3), Messaging (B3)
transports: Http, Spring Cloud Stream Compatible (e.g. RabbitMQ, Kafka, Redis or anything with a custom Binder)
sampling: "Yes"
notes: Java 7 or higher
-
+
+- language: Java
+ library: >-
+ [cassandra-zipkin-tracing](https://github.com/thelastpickle/cassandra-zipkin-tracing)
+ framework: >-
+ [Apache Cassandra](http://cassandra.apache.org)
+ propagation: CQL (B3)
+ transports: Http, Kafka, Scribe
+ sampling: "Yes"
+ notes: Java 8+
+
- language: Scala
library: >-
- [finagle-zipkin](https://github.com/twitter/finagle/tree/develop/finagle-zipkin)
+ [finagle-zipkin](https://github.com/twitter/finagle/tree/develop/finagle-zipkin)
framework: >-
[Finagle](https://github.com/twitter/finagle)
propagation: Http (B3), Thrift
@@ -52,7 +71,7 @@
- language: Ruby
library: >-
- [zipkin-tracer](https://github.com/openzipkin/zipkin-tracer)
+ [zipkin-tracer](https://github.com/openzipkin/zipkin-tracer)
framework: >-
[Rack](http://rack.github.io/)
propagation: Http (B3)
@@ -62,8 +81,8 @@
- language: "C#"
library: >-
- [ZipkinTracerModule](https://github.com/mdsol/Medidata.ZipkinTracerModule)
- framework: OWIN, HttpHandler
+ [ZipkinTracerModule](https://github.com/mdsol/Medidata.ZipkinTracerModule)
+ framework: OWIN, HttpHandler
propagation: Http (B3)
transports: Http
sampling: "Yes"
@@ -79,8 +98,18 @@
- language: Go
library: >-
- [Go kit](https://github.com/go-kit/kit)
- framework: Go kit
+ [monkit-zipkin](https://github.com/spacemonkeygo/monkit-zipkin/)
+ framework: >-
+ [Monkit](https://github.com/spacemonkeygo/monkit/)
+ propagation: Http (B3), easy to add others
+ transports: Scribe, UDP, easy to add others
+ sampling: "Yes"
+
+- language: Go
+ library: >-
+ [zipkin-go-opentracing](https://github.com/openzipkin/zipkin-go-opentracing)
+ framework: >-
+ [Go kit](https://gokit.io) or roll your own with [OpenTracing](http://opentracing.io)
propagation: Http (B3), gRPC (B3)
transports: Kafka, Scribe
sampling: "Yes"
@@ -104,3 +133,15 @@
transports: Http, Scribe
sampling: "Yes"
notes: Java 7 or higher
+
+- language: Java
+ library: >-
+ [Wingtips](https://github.com/Nike-Inc/wingtips)
+ framework: >-
+ [Any Servlet API framework](https://github.com/Nike-Inc/wingtips/tree/master/wingtips-servlet-api),
+ [roll-your-own](https://github.com/Nike-Inc/wingtips#generic-application-pseudo-code),
+ [async framework support](https://github.com/Nike-Inc/wingtips#usage-in-reactive-asynchronous-nonblocking-scenarios)
+ propagation: Http (B3)
+ transports: Http
+ sampling: "Yes"
+ notes: Java 7 or higher, [SLF4J MDC support](https://github.com/Nike-Inc/wingtips#mdc_info) for auto-tagging all log messages with tracing info
diff --git a/pages/data_model.md b/pages/data_model.md
index 91d6a2b..43f4a76 100644
--- a/pages/data_model.md
+++ b/pages/data_model.md
@@ -16,8 +16,7 @@
{% highlight json %}
[
- [
- {
+ {
"traceId": "bd7a977555f6b982",
"name": "get",
"id": "bd7a977555f6b982",
@@ -25,7 +24,7 @@
"duration": 386000,
"annotations": [
{
- "endpoint[": {
+ "endpoint": {
"serviceName": "zipkin-query",
"ipv4": "192.168.1.2",
"port": 9411
@@ -152,7 +151,7 @@
"binaryAnnotations": [
{
"key": "jdbc.query",
- "val[[ue": "select `zipkin_spans`.`trace_id`, `zipkin_spans`.`id`, `zipkin_spans`.`name`, `zipkin_spans`.`parent_id`, `z[ipkin_spans`.`debug`, `zipkin_spans`.`start_ts`, `zipkin_spans`.`duration` from `zipkin_spans` where `zipkin_spans`.`trace_id` in (?)",
+ "value": "select `zipkin_spans`.`trace_id`, `zipkin_spans`.`id`, `zipkin_spans`.`name`, `zipkin_spans`.`parent_id`, `zipkin_spans`.`debug`, `zipkin_spans`.`start_ts`, `zipkin_spans`.`duration` from `zipkin_spans` where `zipkin_spans`.`trace_id` in (?)",
"endpoint": {
"serviceName": "zipkin-query",
"ipv4": "192.168.1.2",
diff --git a/pages/quickstart.md b/pages/quickstart.md
index a6b177a..e598c70 100644
--- a/pages/quickstart.md
+++ b/pages/quickstart.md
@@ -3,41 +3,45 @@
weight: 1
---
+
In this section we’ll walk through building and starting an instance of Zipkin
-for checking out Zipkin locally. There are two options: using Docker and running from source. If you are familiar with Docker, this is the preferred method to start. If you are unfamiliar with Docker, try running from source.
+for checking out Zipkin locally. There are three options: using Java, Docker or running from source.
+
+If you are familiar with Docker, this is the preferred method to start. If you are unfamiliar with Docker, try running via Java or from source.
+
+Regardless of how you start Zipkin, browse to http://your_host:9411 to find traces!
{: .message}
## Docker
-The [Docker Zipkin](https://github.com/openzipkin/docker-zipkin) project is able to build docker images, provide scripts and a
-[`docker-compose.yml`](https://github.com/openzipkin/docker-zipkin/blob/master/docker-compose.yml)
-for launching pre-built images. All you need to do is enter the following commands:
+The [Docker Zipkin](https://github.com/openzipkin/docker-zipkin) project is able to build docker images, provide scripts and a [`docker-compose.yml`](https://github.com/openzipkin/docker-zipkin/blob/master/docker-compose.yml)
+for launching pre-built images. The quickest start is to run the latest image directly:
~~~ bash
-git clone https://github.com/openzipkin/docker-zipkin
-cd docker-zipkin
-docker-compose up
+docker run -d -p 9411:9411 openzipkin/zipkin
+~~~
+
+## Java
+
+If you have Java 8 or higher installed, the quickest way to get started is to fetch the [latest release](https://search.maven.org/remote_content?g=io.zipkin.java&a=zipkin-server&v=LATEST&c=exec) as a self-contained executable jar:
+
+~~~ bash
+wget -O zipkin.jar 'https://search.maven.org/remote_content?g=io.zipkin.java&a=zipkin-server&v=LATEST&c=exec'
+java -jar zipkin.jar
~~~
## Running from Source
-Zipkin can be run from source if you are testing new features or chose not to use
-Docker. The [`bin`](https://github.com/openzipkin/zipkin/tree/master/bin)
-directory of the source repository provides scripts to minimize the amount of
-copy-pasting.
+Zipkin can be run from source if you are developing new features. To achieve this, you'll need to get [Zipkin's source](https://github.com/openzipkin/zipkin) and build it.
-1. Get the zipkin source and change to its directory.
+~~~ bash
+# get the latest source
+git clone https://github.com/openzipkin/zipkin
+cd zipkin
+# Build the server and also make its dependencies
+./mvnw -DskipTests --also-make -pl zipkin-server clean install
+# Run the server
+java -jar ./zipkin-server/target/zipkin-server-*exec.jar
+~~~
- ~~~ bash
- git clone https://github.com/openzipkin/zipkin
- cd zipkin
- ~~~
-
-1. In separate terminal windows or tabs, start
- * The query server: `./bin/query`
- * The collector server: `./bin/collector`
- * The web server: `./bin/web`
-
-1. Create dummy traces: `./bin/tracegen`
-
-1. Open the UI at [http://localhost:8080](http://localhost:8080) and look at the traces!
+Stop by and socialize with us on [gitter](https://gitter.im/openzipkin/zipkin), if you end up making something interesting!
