viktoruj/ping_pong

ping_pong

https://github.com/ViktorUJ/cks

镜像概述和主要用途

本项目是一个小型HTTP服务器，能在响应中返回传入请求及元数据，包括发送者的IP地址、所有请求参数和头信息。服务器配置可通过环境变量修改，同时支持CPU和内存负载测试，并提供Prometheus格式指标。运行中的服务器参数可通过API进行修改。

该服务器可作为Docker容器或Kubernetes资源运行（支持x86和ARM平台），也可作为编译后的二进制文件运行或从源码编译。

核心功能和特性

• 返回请求元数据：包含发送者IP、请求参数、头信息等
• 环境变量配置：支持通过环境变量自定义服务器行为
• 负载测试：可模拟CPU和内存负载，支持负载配置文件
• 指标监控：提供Prometheus格式的性能指标
• API控制：支持通过API获取/修改服务器参数、获取系统信息、模拟崩溃等
• 跨平台支持：可在x86/ARM架构的Docker、Kubernetes、Linux、macOS、Windows、Android等环境运行

使用场景和适用范围

适用于API测试、服务监控、负载测试、容器编排测试等场景，尤其适合SRE、开发人员进行服务调试和性能测试。

详细使用方法和配置说明

使用场景示例

运行基础HTTP ping-pong服务器

bash
kubectl run test --image viktoruj/ping_pong

运行自定义服务器名称的HTTP ping-pong服务器

bash
kubectl run test --image viktoruj/ping_pong --env SERVER_NAME=pingPongServer

运行serverName等于podName的HTTP ping-pong服务器

bash
kubectl run test --image viktoruj/ping_pong --env ENABLE_DEFAULT_HOSTNAME=false

运行带内存使用配置的HTTP ping-pong服务器

bash
kubectl run test --image viktoruj/ping_pong --env MEMORY_USAGE_PROFILE='5=60  20=60   1024=360    ' --env ENABLE_LOAD_MEMORY=true

运行带CPU和内存负载及日志的HTTP ping-pong服务器（使用2个CPU核心）

bash
kubectl run test --image viktoruj/ping_pong --env CPU_USAGE_PROFILE='1=400=1=60 1=4=1=60 10=1=4=60' --env ENABLE_LOAD_CPU=true --env ENABLE_LOG_LOAD_CPU=true --env CPU_MAXPROC=2 --env MEMORY_USAGE_PROFILE='5=60  20=60   1024=360  ' --env ENABLE_LOAD_MEMORY=true --env ENABLE_LOG_LOAD_MEMORY=true

运行带10秒启动延迟的HTTP ping-pong服务器

bash
kubectl run test --image viktoruj/ping_pong --env DELAY_START=10

运行带3秒响应延迟和10个工作线程的HTTP ping-pong服务器

bash
kubectl run test --image viktoruj/ping_pong --env RESPONSE_DELAY=3000 --env MAX_RESPONSE_WORKER=10

运行方式

Docker容器

基本运行命令：

bash
docker run -d -p 8080:8080 docker.xuanyuan.run/viktoruj/ping_pong

镜像标签：

• latest：基于scratch镜像，仅包含二进制文件 Dockerfile
• alpine：基于alpine镜像，包含二进制文件和工具 Dockerfile_alpine
• debug：基于amazon/aws-cli镜像，包含工具 Dockerfile_debug_arm 和 Dockerfile_debug_x86

所有镜像支持x86和ARM平台

Kubernetes

参见使用场景示例中的kubectl命令

二进制文件

下载链接：

• windows x86
• windows arm64
• linux arm64
• linux x86
• linux arm
• darwin x86
• darwin arm64
• android arm64

在macOS上运行：

bash
sudo xattr -d com.apple.quarantine ping-pong-darwin-amd64
sudo chmod +x ping-pong-darwin-amd64
./ping-pong-darwin-amd64 
# 或自定义服务器名称
SERVER_NAME=myCustomServer ./ping-pong-linux-amd64

# 检查服务器
curl 127.0.0.1:8080

在Linux上运行：

bash
sudo chmod +x ping-pong-linux-amd64
./ping-pong-linux-amd64
# 或自定义服务器名称
SERVER_NAME=myCustomServer ./ping-pong-linux-amd64

# 检查服务器
curl 127.0.0.1:8080

在Android上运行（使用Termux）：

bash
cp ping-pong-android-arm64 /data/data/com.termux/files/usr/bin/
chmod +x /data/data/com.termux/files/usr/bin/ping-pong-android-arm64
ping-pong-android-arm64 

从源码编译

bash
cd docker/ping_pong/app
go mod tidy
go run app.go # 或 go build app.go

配置说明

API说明

服务器提供以下API端点：

• /ping-pong-api/getVar - 获取所有服务器变量
• /ping-pong-api/setVar - 设置服务器变量
• /ping-pong-api/osInfo - 获取系统信息
• /ping-pong-api/panic - 模拟应用崩溃
• /ping-pong-api/getMetric - 获取性能指标

API使用示例

获取变量

bash
curl {ping-pong服务器IP}:8080/ping-pong-api/getVar -s | jq

响应示例：

json
{
  "cpuMaxProc": 2,
  "cpuProfileStr": "1000=1=1=30",
  "delayStart": 0,
  "enableDefaultHostName": "true",
  "enableLoadCpu": "true",
  "enableLoadMemory": "false",
  "enableLogLoadCpu": "true",
  "enableLogLoadMemory": "false",
  "enableOutput": "true",
  "hostName": "ping_pong_server",
  "logPath": "",
  "memoryProfiles": null,
  "serverName": "ping_pong_server"
}

设置变量

bash
curl -X POST "http://{ping-pong服务器IP}:8080/ping-pong-api/setVar" -H "Content-Type: application/json" -d '{"enableLoadCpu":"true", "cpuProfileStr":"1000=1=1=30","cpuMaxProc":2}' -s | jq

响应示例：

json
{
  "changes": {
    "cpuMaxProc": {
      "new": "2",
      "old": "1"
    },
    "cpuProfileStr": {
      "new": "1000=1=1=30",
      "old": "1000=1=2=30"
    },
    "enableLoadCpu": {
      "new": "true",
      "old": "false"
    }
  },
  "status": "Variables updated. Handlers reloaded."
}

获取系统信息

bash
curl {ping-pong服务器IP}:8080/ping-pong-api/osInfo -s | jq

响应示例（部分）：

json
{
  "architecture": {
    "architecture": "amd64",
    "goamd64": "v4",
    "goarm": ""
  },
  "cpu": {
    "cores": [
      {
        "core": 1,
        "unit": "percentage",
        "usage": 13.7
      },
      {
        "core": 2,
        "unit": "percentage",
        "usage": 7.6
      }
    ]
  }
}

获取性能指标

bash
curl {ping-pong服务器IP}:8080/ping-pong-api/getMetric -s | jq

响应示例：

json
{
  "goroutines": 6,
  "requests_per_minute": 0,
  "requests_per_second": 0,
  "requests_total": 0
}

模拟应用崩溃

bash
curl {ping-pong服务器IP}:8080/ping-pong-api/panic -s

应用日志输出：

Panic occurred: Test panic
exit status 1