nicholasjackson/fake-service

Fake Service 镜像文档

概述

Fake Service 是一款用于测试上游服务通信、服务网格及其他分布式系统场景的模拟服务。它可配置为 HTTP 或 gRPC 服务，支持错误注入、性能模拟、分布式追踪和 CPU 负载模拟等功能，帮助开发和测试人员验证系统在各种条件下的行为。

核心功能和特性

• 多协议支持：可作为 HTTP 或 gRPC 服务运行
• 上游服务调用：支持配置多个上游服务 URI，并行或顺序调用
• 错误注入：模拟服务错误（HTTP/gRPC 错误码）、延迟和限流
• 性能模拟：配置请求响应时间百分位（50%、90%、99%）及方差
• 分布式追踪：支持 Zipkin 和 Datadog 追踪收集器
• 指标收集：支持 Datadog 指标收集
• CPU 负载模拟：可配置指定核心数和负载百分比
• Web UI：HTTP 服务提供可视化界面，展示请求数据和调用链

使用场景和适用范围

• 服务网格（如 Istio、Linkerd）功能测试
• 分布式系统弹性模式验证（超时、重试、熔断）
• 上游服务依赖模拟
• 性能测试环境搭建
• 错误处理流程测试
• 分布式追踪集成验证

使用方法和配置说明

环境变量配置

Fake Service 通过环境变量进行配置，以下是主要参数说明：

Docker 部署示例

基础 HTTP 服务

bash
docker run -d -p 9090:9090 \
  -e NAME="MyTestService" \
  -e MESSAGE="Hello from Fake Service" \
  nicholasjackson/fake-service

带上游调用的 HTTP 服务

bash
docker run -d -p 9090:9090 \
  -e NAME="API" \
  -e UPSTREAM_URIS="http://upstream1:9090,http://upstream2:9090" \
  -e UPSTREAM_WORKERS=2 \
  nicholasjackson/fake-service

gRPC 服务

bash
docker run -d -p 9090:9090 \
  -e SERVER_TYPE="grpc" \
  -e NAME="GRPCService" \
  nicholasjackson/fake-service

带错误注入的服务（20% 概率返回 500 错误）

bash
docker run -d -p 9090:9090 \
  -e ERROR_RATE=0.2 \
  -e ERROR_TYPE="http_error" \
  -e ERROR_CODE=500 \
  nicholasjackson/fake-service

Docker Compose 示例

以下示例展示了一个包含 4 个服务和 Jaeger 追踪的多服务系统：

yaml
version: '3'

services:
  jaeger:
    image: jaegertracing/all-in-one:latest
    ports:
      - "16686:16686"  # Jaeger UI
      - "9411:9411"    # Zipkin 兼容端口
    environment:
      - COLLECTOR_ZIPKIN_HOST_PORT=:9411

  currency:
    image: nicholasjackson/fake-service
    environment:
      - NAME=currency
      - MESSAGE="Currency response"
      - TRACING_ZIPKIN=http://jaeger:9411

  cache:
    image: nicholasjackson/fake-service
    environment:
      - NAME=cache
      - MESSAGE="Cache response"
      - TRACING_ZIPKIN=http://jaeger:9411

  payments:
    image: nicholasjackson/fake-service
    environment:
      - NAME=payments
      - MESSAGE="Payments response"
      - UPSTREAM_URIS=http://currency:9090
      - TRACING_ZIPKIN=http://jaeger:9411

  api:
    image: nicholasjackson/fake-service
    environment:
      - NAME=api
      - MESSAGE="API response"
      - SERVER_TYPE=grpc
      - UPSTREAM_URIS=http://payments:9090,http://cache:9090
      - UPSTREAM_WORKERS=2
      - TRACING_ZIPKIN=http://jaeger:9411

  web:
    image: nicholasjackson/fake-service
    ports:
      - "9090:9090"
    environment:
      - NAME=web
      - MESSAGE="Hello World"
      - UPSTREAM_URIS=grpc://api:9090
      - TRACING_ZIPKIN=http://jaeger:9411

启动命令：

bash
cd examples/docker-compose
docker-compose up

访问 http://localhost:9090 获取服务响应，访问 http://localhost:16686 查看 Jaeger 追踪数据。

分布式追踪

配置 TRACING_ZIPKIN 环境变量指向 Zipkin 兼容收集器（如 Jaeger）后，Fake Service 会使用 OpenTracing 库输出追踪数据，可在 Jaeger 等工具中查看调用链和性能数据。

!https://raw.githubusercontent.com/nicholasjackson/fake-service/master/images/jaeger_tracing.png

错误注入功能

服务错误模拟

配置错误率、错误类型和错误码，模拟服务故障：

bash
docker run -d -p 9090:9090 \
  -e ERROR_RATE=0.2 \  # 20% 请求返回错误
  -e ERROR_TYPE=http_error \
  -e ERROR_CODE=500 \   # HTTP 500 错误
  nicholasjackson/fake-service

服务延迟模拟

配置延迟错误，模拟服务响应缓慢：

bash
docker run -d -p 9090:9090 \
  -e ERROR_RATE=0.3 \    # 30% 请求延迟
  -e ERROR_TYPE=delay \
  -e ERROR_DELAY=2s \    # 延迟 2 秒
  nicholasjackson/fake-service

限流模拟

配置每秒请求上限，超过则返回限流错误：

bash
docker run -d -p 9090:9090 \
  -e RATE_LIMIT=1 \      # 1 请求/秒
  -e RATE_LIMIT_CODE=429 \  # 限流状态码 429
  nicholasjackson/fake-service

CPU 负载模拟

配置核心数和负载百分比，模拟服务计算负载：

bash
docker run -d -p 9090:9090 \
  -e LOAD_CPU_CORES=4 \     # 使用 4 个核心
  -e LOAD_CPU_PERCENTAGE=75 \  # 75% 负载
  nicholasjackson/fake-service

Web UI

HTTP 服务提供可视化界面，访问 /ui 路径查看请求数据和调用链：

!https://raw.githubusercontent.com/nicholasjackson/fake-service/master/images/ui.png

错误状态下的 UI： !https://raw.githubusercontent.com/nicholasjackson/fake-service/master/images/ui-error.png

注意：UI 仅在 SERVER_TYPE=http 时可用。