wandb/weave-trace

Weave Trace Service 镜像文档

1. 镜像概述和主要用途

Weave Trace Service 是由 Weaveworks 提供的分布式追踪服务镜像，专为容器化和微服务架构设计。该服务基于分布式追踪标准，能够捕获、收集和可视化跨多个服务的请求流数据，帮助团队理解服务间的交互模式，快速定位性能问题，并优化系统可靠性。主要用途包括：微服务请求链路追踪、性能瓶颈分析、服务依赖关系图谱构建、分布式系统故障排查。

2. 核心功能和特性

• 分布式请求追踪：支持追踪跨多个微服务的请求路径，记录每个请求经过的服务、处理时间及状态。
• 可视化数据展示：提供直观的Web界面，展示追踪链路、服务依赖图谱和性能指标。
• 多协议支持：兼容OpenTelemetry、Jaeger等主流追踪协议，支持多种数据采集方式。
• 容器环境集成：无缝适配Kubernetes、Docker Swarm等容器编排平台，支持自动服务发现。
• 灵活的采样策略：可配置采样率，平衡追踪数据精度与系统开销。
• 可扩展存储：支持将追踪数据存储到本地文件、Elasticsearch、Cassandra等后端存储。

3. 使用场景和适用范围

• 微服务架构监控：适用于由多个微服务组成的分布式系统，追踪服务间调用流程。
• 性能问题排查：当系统出现响应延迟时，通过追踪数据定位慢服务或异常节点。
• 服务依赖分析：帮助理解系统架构，识别关键服务依赖和潜在的单点故障。
• 容器化应用追踪：在Docker或Kubernetes环境中部署，监控容器化应用的请求流转。
• 开发与生产环境：支持开发测试阶段的问题诊断，以及生产环境的持续性能监控。

4. 使用方法和配置说明

4.1 快速启动

使用以下命令快速启动Weave Trace Service容器：

bash
docker run -d \
  --name weave-trace-service \
  -p 16686:16686 \  # Web UI端口
  -p 4317:4317 \    # gRPC接收端口（OpenTelemetry）
  -p 4318:4318 \    # HTTP接收端口（OpenTelemetry）
  weaveworks/weave-trace-service:latest

4.2 环境变量配置

通过环境变量自定义服务配置，常用环境变量如下：

示例：使用Elasticsearch作为存储后端并设置采样率为0.5：

bash
docker run -d \
  --name weave-trace-service \
  -p 16686:16686 \
  -p 4317:4317 \
  -e STORAGE_BACKEND=elasticsearch \
  -e ES_URL=http://my-es:9200 \
  -e SAMPLING_RATE=0.5 \
  weaveworks/weave-trace-service:latest

4.3 持久化存储

若使用本地文件存储，可挂载数据卷持久化追踪数据：

bash
docker run -d \
  --name weave-trace-service \
  -p 16686:16686 \
  -p 4317:4317 \
  -v ./trace-data:/var/lib/weave-trace \
  -e STORAGE_BACKEND=file \
  weaveworks/weave-trace-service:latest

4.4 集成服务发现

在Kubernetes环境中，可通过Service资源暴露Weave Trace Service，并配置应用使用服务名进行数据上报：

yaml
# Kubernetes Service示例
apiVersion: v1
kind: Service
metadata:
  name: weave-trace-service
spec:
  selector:
    app: weave-trace-service
  ports:
    - port: 4317
      targetPort: 4317
      name: grpc
    - port: 16686
      targetPort: 16686
      name: ui

应用可通过 weave-trace-service:4317 地址向追踪服务上报数据。

5. 注意事项

• 生产环境建议使用Elasticsearch等分布式存储后端，避免本地文件存储的性能瓶颈。
• 根据系统流量调整采样率，高流量场景下可降低采样率以减少资源消耗。
• 确保追踪服务与被监控服务之间网络通畅，特别是在跨命名空间或跨集群部署时。