基於CentOS搭建基於 ZIPKIN 的數據追蹤系統

系統要求：CentOS 7.2 64 位操作系統

配置 Java 環境

安裝 JDK

Zipkin 使用 Java8

yum install java-1.8.0-openjdk* -y

安裝完成后，查看是否安裝成功：

java -version

安裝 Zipkin

新建目錄

mkdir -p /data/release/zipkin && cd "$_"

下載 Zipkin

wget -O zipkin.jar 'https://search.maven.org/remote_content?g=io.zipkin.java&a=zipkin-server&v=LATEST&c=exec'

啟動 Zipkin

java -jar zipkin.jar

Zipkin 默認監聽 9411 端口， 使用瀏覽器訪問 http://118.89.65.22:9411 即可看到 Zipkin 自帶的圖形化界面(外網：請確認此CVM有外網IP且安全組已開通9411端口)。

配置 MySQL 數據持久化方案

Zipkin 支持的持久化方案很多，如： Cassandra, MySQL, Elasticsearch。本實驗使用 MySQL 5.7 作為數據持久化方案。

安裝 MySQL 5.7

使用 Ctrl + C 退出上個步驟的 Java 進程並下載 rmp 包

wget http://dev.mysql.com/get/mysql57-community-release-el7-9.noarch.rpm

安裝 rpm 包

rpm -Uvh mysql57-community-release-el7-9.noarch.rpm

安裝 MySQL

yum install mysql-community-server -y

啟動 MySQL 服務

systemctl start mysqld.service

設置 MySQL 密碼

獲取 root 臨時密碼(下面命令中的密碼是教程為您自動生成的，為了方便實驗的進行，不建議使用其它密碼。如果設置其它密碼，請把密碼記住，在后續的步驟會使用到)

grep 'temporary password' /var/log/mysqld.log | awk '{print $NF}'

使用上一步的獲得的臨時密碼登入 MySQL

mysql -uroot -p

設置 MySQL 賬戶 root 密碼

ALTER USER 'root'@'localhost' IDENTIFIED BY 'Xx$Zipkin2017';

退出 MySQL, 回到 Bash shell

exit;

初始化 Zipkin 數據庫

編寫初始化腳本

請在 /data/release/zipkin 目錄下創建 zipkin_init.sql，參考下面的內容。

CREATE TABLE IF NOT EXISTS zipkin_spans (
  `trace_id_high` BIGINT NOT NULL DEFAULT 0 COMMENT 'If non zero, this means the trace uses 128 bit traceIds instead of 64 bit',
  `trace_id` BIGINT NOT NULL,
  `id` BIGINT NOT NULL,
  `name` VARCHAR(255) NOT NULL,
  `parent_id` BIGINT,
  `debug` BIT(1),
  `start_ts` BIGINT COMMENT 'Span.timestamp(): epoch micros used for endTs query and to implement TTL',
  `duration` BIGINT COMMENT 'Span.duration(): micros used for minDuration and maxDuration query'
) ENGINE=InnoDB ROW_FORMAT=COMPRESSED CHARACTER SET=utf8 COLLATE utf8_general_ci;

ALTER TABLE zipkin_spans ADD UNIQUE KEY(`trace_id_high`, `trace_id`, `id`) COMMENT 'ignore insert on duplicate';
ALTER TABLE zipkin_spans ADD INDEX(`trace_id_high`, `trace_id`, `id`) COMMENT 'for joining with zipkin_annotations';
ALTER TABLE zipkin_spans ADD INDEX(`trace_id_high`, `trace_id`) COMMENT 'for getTracesByIds';
ALTER TABLE zipkin_spans ADD INDEX(`name`) COMMENT 'for getTraces and getSpanNames';
ALTER TABLE zipkin_spans ADD INDEX(`start_ts`) COMMENT 'for getTraces ordering and range';

CREATE TABLE IF NOT EXISTS zipkin_annotations (
  `trace_id_high` BIGINT NOT NULL DEFAULT 0 COMMENT 'If non zero, this means the trace uses 128 bit traceIds instead of 64 bit',
  `trace_id` BIGINT NOT NULL COMMENT 'coincides with zipkin_spans.trace_id',
  `span_id` BIGINT NOT NULL COMMENT 'coincides with zipkin_spans.id',
  `a_key` VARCHAR(255) NOT NULL COMMENT 'BinaryAnnotation.key or Annotation.value if type == -1',
  `a_value` BLOB COMMENT 'BinaryAnnotation.value(), which must be smaller than 64KB',
  `a_type` INT NOT NULL COMMENT 'BinaryAnnotation.type() or -1 if Annotation',
  `a_timestamp` BIGINT COMMENT 'Used to implement TTL; Annotation.timestamp or zipkin_spans.timestamp',
  `endpoint_ipv4` INT COMMENT 'Null when Binary/Annotation.endpoint is null',
  `endpoint_ipv6` BINARY(16) COMMENT 'Null when Binary/Annotation.endpoint is null, or no IPv6 address',
  `endpoint_port` SMALLINT COMMENT 'Null when Binary/Annotation.endpoint is null',
  `endpoint_service_name` VARCHAR(255) COMMENT 'Null when Binary/Annotation.endpoint is null'
) ENGINE=InnoDB ROW_FORMAT=COMPRESSED CHARACTER SET=utf8 COLLATE utf8_general_ci;

ALTER TABLE zipkin_annotations ADD UNIQUE KEY(`trace_id_high`, `trace_id`, `span_id`, `a_key`, `a_timestamp`) COMMENT 'Ignore insert on duplicate';
ALTER TABLE zipkin_annotations ADD INDEX(`trace_id_high`, `trace_id`, `span_id`) COMMENT 'for joining with zipkin_spans';
ALTER TABLE zipkin_annotations ADD INDEX(`trace_id_high`, `trace_id`) COMMENT 'for getTraces/ByIds';
ALTER TABLE zipkin_annotations ADD INDEX(`endpoint_service_name`) COMMENT 'for getTraces and getServiceNames';
ALTER TABLE zipkin_annotations ADD INDEX(`a_type`) COMMENT 'for getTraces';
ALTER TABLE zipkin_annotations ADD INDEX(`a_key`) COMMENT 'for getTraces';
ALTER TABLE zipkin_annotations ADD INDEX(`trace_id`, `span_id`, `a_key`) COMMENT 'for dependencies job';

CREATE TABLE IF NOT EXISTS zipkin_dependencies (
  `day` DATE NOT NULL,
  `parent` VARCHAR(255) NOT NULL,
  `child` VARCHAR(255) NOT NULL,
  `call_count` BIGINT
) ENGINE=InnoDB ROW_FORMAT=COMPRESSED CHARACTER SET=utf8 COLLATE utf8_general_ci;

ALTER TABLE zipkin_dependencies ADD UNIQUE KEY(`day`, `parent`, `child`);

登錄 Mysql

mysql -u root --password='Xx$Zipkin2017'

創建 Zipkin 數據庫

create database zipkin;

切換數據庫

use zipkin;

初始化表及索引

source /data/release/zipkin/zipkin_init.sql

執行以下命令會看到zipkin_annotations, zipkin_dependencies, zipkin_spans 三張數據表，說明初始化成功了

show tables;

退出 MySQL, 回到 Bash shell

exit

啟動 Zipkin

注： 此處默認使用實驗生成的密碼

cd /data/release/zipkin
STORAGE_TYPE=mysql MYSQL_HOST=localhost MYSQL_TCP_PORT=3306 MYSQL_DB=zipkin MYSQL_USER=root MYSQL_PASS='Xx$Zipkin2017' \
nohup java -jar zipkin.jar &

創建具有數據上報能力的Demo

搭建 NodeJS 環境

curl --silent --location https://rpm.nodesource.com/setup_8.x | sudo bash -
yum install nodejs -y

創建Demo目錄

創建/data/release/service_a目錄

mkdir -p /data/release/service_a && cd "$_"

使用 NPM 安裝相關依賴

請在 /data/release/service_a 目錄下創建並編輯 package.json，參考下面的內容。

 

{
  "name": "service_a",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {},
  "author": "",
  "license": "ISC",
  "dependencies": {
    "express": "^4.15.3",
    "zipkin": "^0.7.2",
    "zipkin-instrumentation-express": "^0.7.2",
    "zipkin-transport-http": "^0.7.2"
  }
}

安裝相關依賴

npm install

創建並編輯 app.js

請在 /data/release/service_a 目錄下創建 app.js，參考下面的內容。

示例代碼：/data/release/service_a/app.js

const express = require('express');
const {Tracer, ExplicitContext, BatchRecorder} = require('zipkin');
const {HttpLogger} = require('zipkin-transport-http');
const zipkinMiddleware = require('zipkin-instrumentation-express').expressMiddleware;

const ctxImpl = new ExplicitContext();
const recorder = new BatchRecorder({
    logger: new HttpLogger( {
        endpoint: 'http://127.0.0.1:9411/api/v1/spans'
    })
});

const tracer = new Tracer({ctxImpl, recorder});

const app = express();

app.use(zipkinMiddleware({
  tracer,
  serviceName: 'service-a'
}));

app.use('/', (req, res, next) => {
    res.send('hello world');
});

app.listen(3000, () => {
  console.log('service-a listening on port 3000!')
});

啟動服務

node app.js

該服務監聽 3000 端口， 使用瀏覽器訪問 http://118.89.65.22:3000 后，看到“hello world” 的文本字樣說明服務已經正常工作。

部署完成

查看采集到的追蹤數據

使用瀏覽器訪問  http://118.89.65.22:9411 即可看到剛才訪問產生的追蹤數據。

至此，本入門教程已結束，而 Zipkin 的學習只是一個開始，如有興趣，可嘗試搭建一個基於 Kafka + Zookeeper + Elasticsearch 的分布式服務。

大功告成

恭喜您已經完成了搭建基於 ZIPKIN 的數據追蹤系統的學習。