This repository contains the Docker build definition and release process for openzipkin/zipkin. It also contains test images for transport and storage backends such as Cassandra.
Automatically built images are available on Quay.io under the OpenZipkin organization, and are mirrored to Docker Hub.
Zipkin has no dependencies, for example you can run an in-memory zipkin server like so:
docker run -d -p 9411:9411 openzipkin/zipkin
See the ui at (docker ip):9411
In the ui - click zipkin-server, then click "Find Traces".
Configuration is via environment variables, defined by zipkin-server. Notably, you'll want to look at the STORAGE_TYPE environment variables, which
include "cassandra", "mysql" and "elasticsearch".
When in docker, the following environment variables also apply
JAVA_OPTS: Use to set java arguments, such as heap size or trust store location.STORAGE_PORT_9042_TCP_ADDR-- A Cassandra node listening on port 9042. This environment variable is typically set by linking a container runningzipkin-cassandraas "storage" when you start the container.STORAGE_PORT_3306_TCP_ADDR-- A MySQL node listening on port 3306. This environment variable is typically set by linking a container runningzipkin-mysqlas "storage" when you start the container.STORAGE_PORT_9300_TCP_ADDR-- An Elasticsearch node listening on port 9300. This environment variable is typically set by linking a container runningzipkin-elasticsearchas "storage" when you start the container.KAFKA_PORT_2181_TCP_ADDR-- A zookeeper node listening on port 2181. This environment variable is typically set by linking a container runningzipkin-kafkaas "kafka" when you start the container.
This project is configured to run docker containers using docker-compose. Note that the default configuration requires docker-compose 1.6.0+ and docker-engine 1.10.0+. If you are running older versions, see the Legacy section below.
To start the default docker-compose configuration, run:
$ docker-compose up
View the web UI at $(docker ip):8080.
To see specific traces in the UI, select "zipkin-server" in the dropdown and then click the "Find Traces" button.
The default docker-compose configuration defined in docker-compose.yml is
backed by a single-node Cassandra. This configuration starts zipkin,
zipkin-cassandra and zipkin-dependencies (cron job) in their own containers.
The docker-compose configuration can be extended to use MySQL instead of
Cassandra, using the docker-compose-mysql.yml file. That file employs
docker-compose overrides
to swap out one storage container for another.
To start the MySQL-backed configuration, run:
$ docker-compose -f docker-compose.yml -f docker-compose-mysql.yml up
The docker-compose configuration can be extended to use Elasticsearch instead of
Cassandra, using the docker-compose-elasticsearch.yml file. That file employs
docker-compose overrides
to swap out one storage container for another.
To start the Elasticsearch-backed configuration, run:
$ docker-compose -f docker-compose.yml -f docker-compose-elasticsearch.yml up
The docker-compose configuration can be extended to host a test Kafka broker
using the docker-compose-kafka.yml file. That file employs
docker-compose overrides
to add a Kafka+ZooKeeper container and relevant settings.
To start the Cassandra+Kafka configuration, run:
$ docker-compose -f docker-compose.yml -f docker-compose-kafka.yml up
By default, this assumes your Docker host IP is 192.168.99.100, which is what you would use for the broker IP when configuring application instrumentation.
The docker-compose files described above use version 2 of the docker-compose
config file format. There is a legacy version 1 configuration also available, in
docker-compose-legacy.yml. That configuration relies on container linking.
To start the legacy configuration, run:
$ docker-compose -f docker-compose-legacy.yml up
All images share a base image, openzipkin/jre-full, built on the Alpine image
delitescere/java:8, which is much
smaller than the previously used debian:sidd image.