openzipkin/zipkin-aws

zipkin-aws

镜像概述和主要用途

zipkin-aws 提供 Zipkin 与 AWS Kinesis、SQS 和 X-Ray 的集成功能，是 Zipkin 分布式追踪系统在 AWS 环境下的扩展组件。该镜像需要 JRE 8 或更高版本运行环境。

核心功能和特性

zipkin-aws 提供以下核心组件：

• Reporters（报告器）：负责处理出站追踪数据（跨度）的队列和编码
• Senders（发送器）：实现特定技术的有线协议，用于发送编码后的追踪数据
• Collectors（收集器）：用于 Zipkin 服务器接收追踪数据，解码后持久化到存储组件

这些组件基于以下项目构建：

• https://github.com/openzipkin/zipkin-reporter-java 提供的接口
• https://github.com/openzipkin/zipkin 服务器

使用场景和适用范围

适用于在 AWS 环境中部署 Zipkin 分布式追踪系统的场景，特别是需要：

• 通过 AWS 服务（如 Kinesis、SQS）传输追踪数据
• 与 AWS X-Ray 集成的应用程序
• 在 AWS 基础设施上构建微服务架构的分布式追踪系统

详细的使用方法和配置说明

Reporters 和 Senders

Reporters

Senders

Collectors

服务器集成

要与 zipkin-server 集成，需要使用属性启动器加载收集器（或发送器）与 zipkin-server 进程一起运行：

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

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

示例命令：

bash
java -Dloader.path=sqs.jar -Dspring.profiles.active=sqs -cp zipkin.jar org.springframework.boot.loader.PropertiesLauncher

SQS Collector 集成示例

步骤 1：下载 zipkin-server jar

bash
cd /tmp
curl -sSL https://zipkin.io/quickstart.sh | bash -s

步骤 2：下载最新的 sqs-module jar

bash
cd /tmp
curl -sSL https://zipkin.io/quickstart.sh | bash -s io.zipkin.aws:zipkin-module-collector-sqs:LATEST:module sqs.jar

步骤 3：使用 "sqs" 配置文件运行服务器

bash
cd /tmp
SQS_QUEUE_URL=<from aws sqs list-queues> \
    java \
    -Dloader.path='sqs.jar,sqs.jar!/lib' \
    -Dspring.profiles.active=sqs \
    -cp zipkin.jar \
    org.springframework.boot.loader.PropertiesLauncher

注意：确保参数在同一行定义或使用环境变量

Docker 部署方案示例

Docker Run 命令

bash
docker run -d \
  --name zipkin-aws \
  -e SQS_QUEUE_URL=https://sqs.<region>.amazonaws.com/<account-id>/<queue-name> \
  -e AWS_REGION=<region> \
  -p 9411:9411 \
  -v /path/to/config:/config \
  quay.io/openzipkin/zipkin-aws \
  --spring.profiles.active=sqs \
  --loader.path=/config

Docker Compose 配置

yaml
version: '3'
services:
  zipkin-aws:
    image: quay.io/openzipkin/zipkin-aws
    container_name: zipkin-aws
    ports:
      - "9411:9411"
    environment:
      - SQS_QUEUE_URL=https://sqs.<region>.amazonaws.com/<account-id>/<queue-name>
      - AWS_REGION=<region>
      - SPRING_PROFILES_ACTIVE=sqs
    volumes:
      - ./config:/config
    command: --loader.path=/config
    restart: always

环境变量配置

工件信息

所有工件发布到 group ID "io.zipkin.aws"：

• 发布版本：上传到 Bintray 并同步到 Maven Central
• 快照版本：提交到 master 后上传到 JFrog