openzipkin/zipkin-gcp

zipkin-gcp

提供Zipkin与Google Cloud Platform集成的共享库，需JRE 8或更高版本。

概述

zipkin-gcp是一套共享库，通过Zipkin和zipkin-reporter-java中定义的接口，使追踪应用和服务器能与Google Cloud服务集成。

核心功能与特性

发送器（Senders）

发送器是追踪应用中用于将时序数据（跨度）发送到进程外的组件，由异步报告器按间隔调用。

收集器（Collectors）

收集器是Zipkin服务器中接收追踪数据的组件，负责解码应用报告的跨度并将其持久化到配置的存储组件中。当前暂无可用收集器。

存储（Storage）

存储组件（StorageComponent）是Zipkin服务器中用于持久化和查询收集数据的组件，主要支持Zipkin API及所有收集器组件。

使用场景

适用于需要通过Google Cloud服务进行分布式追踪的应用，尤其适合使用Stackdriver Trace作为追踪数据存储和发送目标的场景。

使用方法与配置说明

服务器集成

要与zipkin-server集成，需使用属性启动器在zipkin-server进程中加载收集器（或发送器）。步骤如下：

1. 将模块JAR添加到loader.path
2. 启用与模块关联的配置文件
3. 使用PropertiesLauncher启动Zipkin

每个模块还需设置不同的最小变量。

示例

bash
$ curl -sSL https://zipkin.io/quickstart.sh | bash -s
$ curl -sSL https://zipkin.io/quickstart.sh | bash -s io.zipkin.gcp:zipkin-module-storage-stackdriver:LATEST:module stackdriver.jar
$ STORAGE_TYPE=stackdriver STACKDRIVER_PROJECT_ID=zipkin-demo \
    java \
    -Dloader.path='stackdriver.jar,stackdriver.jar!/lib' \
    -Dspring.profiles.active=stackdriver \
    -cp zipkin.jar \
    org.springframework.boot.loader.PropertiesLauncher

故障排除

翻译问题

使用向Stackdriver发送数据的组件时，若控制台无输出，可启用翻译组件的DEBUG日志（Spring Boot环境）：

bash
-Dlogging.level.zipkin2=DEBUG

启用后将看到翻译输入和输出，例如：

2018-04-09 13:58:44.112 DEBUG [/] 11325 --- [   XNIO-2 I/O-3] z.t.stackdriver.SpanTranslator           : >> translating zipkin span: {"traceId":"d42316227862f939","parentId":"d42316227862f939","id":"dfbb21f9cf4c52b3","kind":"CLIENT","name":"get","timestamp":1523253523054380,"duration":4536,"localEndpoint":{"serviceName":"frontend","ipv4":"192.168.1.113"},"tags":{"http.method":"GET","http.path":"/api"}}
2018-04-09 13:58:44.113 DEBUG [/] 11325 --- [   XNIO-2 I/O-3] z.t.stackdriver.SpanTranslator           : << translated to stackdriver span: span_id: 16199746076534411288
kind: RPC_CLIENT
name: "get"
start_time {
  seconds: 1523253523
  nanos: 54380000
}
end_time {
  seconds: 1523253523
  nanos: 58916000
}
parent_span_id: 15286085897530046777
labels {
  key: "/http/method"
  value: "GET"
}
labels {
  key: "zipkin.io/http.path"
  value: "/api"
}
labels {
  key: "/component"
  value: "frontend"
}

健康检查API

运行Zipkin服务器时，可通过/health HTTP端点检查服务健康状态。

gRPC头信息

若怀疑Zipkin服务器与Stackdriver之间存在问题，可设置环境变量STACKDRIVER_HTTP_LOGGING=HEADERS以记录gRPC状态信息。

GCP控制台

若认为跨度已到达Stackdriver，可通过GCP控制台的“API和服务 > 仪表板 > Stackdriver Trace API > 指标”部分验证：

• 检查是否有流量，若无则请求未到达Stackdriver，需检查应用/代理配置。
• 检查是否有错误，可通过筛选凭据和方法查看“按API方法错误”图表或“方法”表格。
  • 若所有写入失败，检查服务账号是否有cloudtrace.agent角色或cloudtrace.traces.patch权限。
  • 若读取失败，检查cloudtrace.user角色或特定权限（读写权限分离，仅管理员角色同时拥有）。

artifacts

所有artifacts发布到组ID“io.zipkin.gcp”，所有组件使用统一的发布版本。

库发布

发行版上传至Bintray并同步到Maven Central。

库快照

快照在提交到master后上传至JFrog。