openzipkin/zipkin-kafka

docker-zipkin

https://travis-ci.org/openzipkin/docker-zipkin.svg](https://travis-ci.org/openzipkin/docker-zipkin) https://quay.io/repository/openzipkin/zipkin/status "zipkin"](https://quay.io/repository/openzipkin/zipkin) https://quay.io/repository/openzipkin/zipkin-slim/status "zipkin-slim"](https://quay.io/repository/openzipkin/zipkin-slim) https://quay.io/repository/openzipkin/zipkin-cassandra/status "zipkin-cassandra"](https://quay.io/repository/openzipkin/zipkin-cassandra) https://quay.io/repository/openzipkin/zipkin-mysql/status "zipkin-mysql"](https://quay.io/repository/openzipkin/zipkin-mysql) https://quay.io/repository/openzipkin/zipkin-elasticsearch/status "zipkin-elasticsearch"](https://quay.io/repository/openzipkin/zipkin-elasticsearch) https://quay.io/repository/openzipkin/zipkin-elasticsearch5/status "zipkin-elasticsearch5"](https://quay.io/repository/openzipkin/zipkin-elasticsearch5) https://quay.io/repository/openzipkin/zipkin-elasticsearch6/status "zipkin-elasticsearch6"](https://quay.io/repository/openzipkin/zipkin-elasticsearch6) https://quay.io/repository/openzipkin/zipkin-kafka/status "zipkin-kafka"](https://quay.io/repository/openzipkin/zipkin-kafka) https://quay.io/repository/openzipkin/zipkin-ui/status "zipkin-ui"](https://quay.io/repository/openzipkin/zipkin-ui)

本仓库包含https://github.com/openzipkin/zipkin%E7%9A%84Docker%E6%9E%84%E5%BB%BA%E5%AE%9A%E4%B9%89%E5%92%8C%E5%8F%91%E5%B8%83%E6%B5%81%E7%A8%8B%E3%80%82%E5%AE%83%E8%BF%98%E5%8C%85%E5%90%AB%E4%BC%A0%E8%BE%93%E5%92%8C%E5%AD%98%E5%82%A8%E5%90%8E%E7%AB%AF%EF%BC%88%E5%A6%82Kafka%E6%88%96Cassandra%EF%BC%89%E7%9A%84%E6%B5%8B%E8%AF%95%E9%95%9C%E5%83%8F%E3%80%82

自动构建的镜像可在Quay.io的https://quay.io/organization/openzipkin%E7%BB%84%E7%BB%87%E4%B8%8B%E8%8E%B7%E5%8F%96%EF%BC%8C%E5%B9%B6%E9%95%9C%E5%83%8F%E5%88%B0https://hub.docker.com/u/openzipkin/%E3%80%82

关于生产使用

OpenZipkin提供的仅用于生产环境的镜像有：

• openzipkin/zipkin：核心服务器镜像，托管Zipkin UI、API和Collector功能。
• openzipkin/zipkin-slim：精简版服务器镜像，托管Zipkin UI和API功能，但仅支持内存或Elasticsearch存储，以及HTTP或gRPC span收集器。
• https://github.com/openzipkin/docker-zipkin-dependencies%EF%BC%9A%E9%A2%84%E8%81%9A%E5%90%88%E6%95%B0%E6%8D%AE%EF%BC%8C%E4%BD%BF [***] 能显示服务间的链接。

如果使用这些镜像时遇到问题，请提交issue或加入https://gitter.im/openzipkin/zipkin%E3%80%82

此处的其他镜像和docker-compose配置仅用于开发和探索目的。例如，它们旨在帮助您集成整个Zipkin系统进行测试，而无需了解所有组件的工作原理，也无需下载大量文件。

例如，openzipkin/zipkin-cassandra并非为实际使用设计。您会发现它没有配置支持多节点合理运行，也没有像“实际环境”那样处理文件系统。我们期望生产用户使用存储或传输（如Kafka）的标准镜像，只有测试或学习Zipkin的用户才使用此处提供的镜像。

运行

Zipkin无依赖，例如您可以这样运行内存中的Zipkin服务器： docker run -d -p 9411:9411 openzipkin/zipkin-slim

在 (docker ip):9411 访问UI。

在UI中，点击zipkin-server，然后点击“Find Traces”。

配置

配置通过环境变量进行，由https://github.com/openzipkin/zipkin/blob/master/zipkin-server/README.md%E5%AE%9A%E4%B9%89%E3%80%82%E5%80%BC%E5%BE%97%E6%B3%A8%E6%84%8F%E7%9A%84%E6%98%AF%EF%BC%8C%E6%82%A8%E9%9C%80%E8%A6%81%E6%9F%A5%E7%9C%8B%60STORAGE_TYPE%60%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%EF%BC%8C%E5%85%B6%E5%8F%96%E5%80%BC%E5%8C%85%E6%8B%AC%22cassandra%22%E3%80%81%22mysql%22%E5%92%8C%22elasticsearch%22%E3%80%82

注意：openzipkin/zipkin-slim镜像仅支持"elasticsearch"存储。要使用其他存储类型，必须使用主镜像openzipkin/zipkin。

在Docker中，以下环境变量也适用：

• JAVA_OPTS：用于设置Java参数，如堆大小或信任库位置。
• STORAGE_PORT_9042_TCP_ADDR——监听9042端口的Cassandra节点。启动容器时，通常通过将运行zipkin-cassandra的容器链接为“storage”来设置此环境变量。
• STORAGE_PORT_3306_TCP_ADDR——监听3306端口的MySQL节点。启动容器时，通常通过将运行zipkin-mysql的容器链接为“storage”来设置此环境变量。
• STORAGE_PORT_9200_TCP_ADDR——监听9200端口的Elasticsearch节点。启动容器时，通常通过将运行zipkin-elasticsearch的容器链接为“storage”来设置此环境变量。当设置ES_HOSTS或ES_AWS_DOMAIN时，此变量将被忽略。
• KAFKA_PORT_2181_TCP_ADDR——监听2181端口的Zookeeper节点。启动容器时，通常通过将运行zipkin-kafka的容器链接为“kafka”来设置此环境变量。

例如，要添加调试日志，可像我们的docker-compose文件中那样设置JAVA_OPTS：

yaml
      - JAVA_OPTS=-Dlogging.level.zipkin=DEBUG -Dlogging.level.zipkin2=DEBUG

运行时用户

openzipkin/zipkin和openzipkin/zipkin-slim镜像在名为'zipkin'的nologin用户下运行，主目录为'/zipkin'。由于这是无发行版镜像，不会安装许多工具，但您可以通过如下shell浏览内容：

bash
$ docker run -it --rm --entrypoint /busybox/sh openzipkin/zipkin
/zipkin $ ls
BOOT-INF  META-INF  org       run.sh

docker-compose

本项目配置为使用https://docs.docker.com/compose/%E8%BF%90%E8%A1%8CDocker%E5%AE%B9%E5%99%A8%E3%80%82%E6%B3%A8%E6%84%8F%EF%BC%8C%E9%BB%98%E8%AE%A4%E9%85%8D%E7%BD%AE%E9%9C%80%E8%A6%81docker-compose 1.6.0+和docker-engine 1.10.0+。

要启动默认的docker-compose配置，运行：

$ docker-compose up

在 $(docker ip):9411 查看Web UI。

要在UI中查看特定跟踪，在下拉菜单中选择“zipkin-server”，然后点击“Find Traces”按钮。

Slim版

要启动更小更快的Zipkin发行版，运行：

bash
$ docker-compose -f docker-compose-slim.yml up

这将启动内存存储。Slim版唯一支持的其他存储选项是Elasticsearch：

bash
$ docker-compose -f docker-compose-slim.yml -f docker-compose-elasticsearch.yml up

MySQL

docker-compose.yml中定义的默认docker-compose配置由MySQL支持。此配置在各自的容器中启动zipkin、zipkin-mysql和zipkin-dependencies（定时任务）。

Cassandra

可使用docker-compose-cassandra.yml文件扩展docker-compose配置，以使用Cassandra代替MySQL。该文件采用https://docs.docker.com/compose/extends/#multiple-compose-files%E6%9B%BF%E6%8D%A2%E5%AD%98%E5%82%A8%E5%AE%B9%E5%99%A8%E3%80%82

要启动Cassandra后端配置，运行：

$ docker-compose -f docker-compose.yml -f docker-compose-cassandra.yml up

Elasticsearch

可使用docker-compose-elasticsearch.yml文件扩展docker-compose配置，以使用Elasticsearch代替MySQL。该文件采用https://docs.docker.com/compose/extends/#multiple-compose-files%E6%9B%BF%E6%8D%A2%E5%AD%98%E5%82%A8%E5%AE%B9%E5%99%A8%E3%80%82

要启动Elasticsearch后端配置，运行：

$ docker-compose -f docker-compose.yml -f docker-compose-elasticsearch.yml up

Elasticsearch 5+ 和主机设置

zipkin-elasticsearch5和zipkin-elasticsearch6镜像对虚拟内存https://github.com/docker-library/docs/tree/master/elasticsearch#host-setup%E3%80%82%E6%82%A8%E9%9C%80%E8%A6%81%E7%9B%B8%E5%BA%94%E8%B0%83%E6%95%B4%EF%BC%88%E5%B0%A4%E5%85%B6%E6%98%AF%E6%B3%A8%E6%84%8FElasticsearch%E5%B4%A9%E6%BA%83%E6%97%B6%EF%BC%81%EF%BC%89

bash
# 如果Docker在主机上运行，直接调整内核设置
$ sudo sysctl -w vm.max_map_count=262144

# 如果使用docker-machine/Docker Toolbox/Boot2Docker，远程调整相同设置
$ docker-machine ssh default "sudo sysctl -w vm.max_map_count=262144"

Kafka

可使用docker-compose-kafka.yml文件扩展docker-compose配置，以托管测试Kafka broker并激活https://github.com/openzipkin/zipkin/tree/master/zipkin-collector/kafka%E3%80%82%E8%AF%A5%E6%96%87%E4%BB%B6%E9%87%87%E7%94%A8https://docs.docker.com/compose/extends/#multiple-compose-files%E6%B7%BB%E5%8A%A0Kafka+ZooKeeper%E5%AE%B9%E5%99%A8%E5%92%8C%E7%9B%B8%E5%85%B3%E8%AE%BE%E7%BD%AE%E3%80%82

要启动MySQL+Kafka配置，运行：

$ docker-compose -f docker-compose.yml -f docker-compose-kafka.yml up

然后配置https://github.com/openzipkin/zipkin-reporter-java/blob/master/kafka11/src/main/java/zipkin2/reporter/kafka11/KafkaSender.java%EF%BC%8C%E8%8B%A5%E5%BA%94%E7%94%A8%E5%9C%A8%E5%90%8C%E4%B8%80Docker%E7%BD%91%E7%BB%9C%E4%B8%AD%EF%BC%8C%60bootstrapServers%60%E5%80%BC%E8%AE%BE%E4%B8%BA%60host.docker.internal:9092%60%EF%BC%9B%E8%8B%A5%E4%B8%8D%E5%9C%A8%E5%90%8C%E4%B8%80%E7%BD%91%E7%BB%9C%E4%BD%86%E5%9C%A8%E5%90%8C%E4%B8%80%E4%B8%BB%E6%9C%BA%E4%B8%8A%EF%BC%8C%E8%AE%BE%E4%B8%BA%60localhost:19092%60%E3%80%82

换句话说，如果您在笔记本电脑上运行示例应用，应使用localhost:19092作为bootstrap server，将span发送到Docker中运行的Kafka broker。

UI

可使用docker-compose-ui.yml文件扩展docker-compose配置，以在80端口托管UI。该文件采用https://docs.docker.com/compose/extends/#multiple-compose-files%E6%B7%BB%E5%8A%A0NGINX%E5%AE%B9%E5%99%A8%E5%92%8C%E7%9B%B8%E5%85%B3%E8%AE%BE%E7%BD%AE%E3%80%82

要启动NGINX配置，运行：

$ docker-compose -f docker-compose.yml -f docker-compose-ui.yml up

此容器还可作为围绕Zipkin创建代理配置的框架，如身份验证、处理zipkin-js应用的CORS或终止SSL。

Prometheus

Zipkin内置Prometheus指标导出器。主docker-compose.yml文件启动配置为抓取Zipkin的Prometheus，暴露在9090端口。您可以打开$DOCKER_HOST_IP:9090并开始探索指标（可在Zipkin的/prometheus端点获取）。

docker-compose.yml还启动禁用身份验证的Grafana容器，暴露在3000端口。启动时，它配置docker-compose启动的Prometheus实例作为数据源，并导入在https://grafana.com/dashboards/1598%E5%8F%91%E5%B8%83%E7%9A%84%E4%BB%AA%E8%A1%A8%E6%9D%BF%E3%80%82%E8%BF%99%E6%84%8F%E5%91%B3%E7%9D%80%EF%BC%8C%E8%BF%90%E8%A1%8C%60docker-compose up后，您可以打开$DOCKER_IP:3000/dashboard/db/zipkin-prometheus`并使用该仪表板。

如果要独立运行zipkin-ui以连接远程Zipkin服务器，需相应设置ZIPKIN_BASE_URL：

bash
$ docker run -d -p 80:80 \
  -e ZIPKIN_BASE_URL=http://myfavoritezipkin:9411 \
  openzipkin/zipkin-ui

遗留内容

Docker machine和Kafka

如果使用Docker machine，调整docker-compose-kafka.yml中的KAFKA_ADVERTISED_HOST_NAME和Kafka sender的bootstrapServers配置，以匹配Docker主机IP（如192.168.99.100:***）。

注意事项

如果使用提供的MySQL服务器或镜像，确保schema和其他参数与https://github.com/openzipkin/zipkin/tree/master/zipkin-storage/mysql-v1#applying-the-schema%E5%8C%B9%E9%85%8D%E3%80%82