chatwork/gatling-ecs-client

Gatling ECS client

镜像概述和主要用途

Gatling ECS client是一款一站式工具，旨在简化在AWS ECS（Elastic Container Service）上运行Gatling性能测试模拟并在Amazon S3中生成测试报告的流程。该工具集成了任务编排、日志存储和报告生成功能，提供了在AWS环境中执行Gatling测试的完整解决方案。

核心功能和特性

• 一站式测试流程：集成Gatling场景执行与S3报告生成，无需手动配置多个组件
• AWS ECS集成：基于FARGATE启动类型管理ECS任务，无需维护EC2实例
• 灵活的日志管理：支持自定义S3日志存储路径，便于测试结果分组管理
• 多环境认证支持：兼容AWS IAM凭证和SSO认证方式
• 第三方通知集成：支持通过Chatwork发送测试完成通知
• 可配置的报告输出：支持自定义报告访问URL，便于结果分享

使用场景和适用范围

适用于需要在AWS云环境中执行性能测试的团队和个人，特别是：

• 基于AWS架构的应用性能评估
• 需要自动化执行和编排的Gatling测试场景
• 需集中存储和共享测试报告的团队协作场景
• 需要将测试结果集成到Chatwork工作流的团队

详细使用要求和配置说明

前置要求

Docker镜像

运行Gatling场景需满足以下条件：

• 镜像必须推送到Docker仓库（DockerHub或ECR）
• 镜像的Cmd必须包含以下操作：
  • 运行Gatling测试场景
  • 将Gatling日志存储到Amazon S3

ECS任务配置

需通过CloudFormation创建以下两个ECS任务定义：

1. 运行器任务（runner）

• 启动类型：FARGATE
• 容器配置：
  • 容器名称：gatling-runner
  • 使用自定义Gatling测试镜像
• 输出要求：堆栈输出必须包含任务定义名称

2. 报告器任务（reporter）

• 启动类型：FARGATE
• 容器配置：
  • 容器名称：gatling-s3-reporter
  • 使用官方镜像：chatwork/gatling-s3-reporter:0.1.1
• 输出要求：堆栈输出必须包含任务定义名称

配置示例：可复制并修改samples/cloudformation/gatling-ecs.template模板创建CloudFormation堆栈。

执行工具的JSON配置文件

工具执行需提供JSON配置文件，结构如下：

json
{
  "taskDefs": {  // 脚本使用的任务定义
    "runner": {},  // [必填] 运行器任务定义
    "reporter": {}  // 报告器任务定义
  },
  "awsSubnet": "",  // [必填] 与任务关联的AWS子网ID
  "awsSecurityGroup": "",  // 与任务关联的AWS安全组ID
  "s3LogPrefix": "",  // S3日志存储前缀，默认自动生成executionId目录；如需分组可指定如"test_group/"
  "reportParams": {
    "hostUrl": ""  // 报告基础URL，设置后输出格式：`[hostUrl]/[execution_id]/index.html`
  },
  "chatworkNotificationParams": {  // Chatwork通知参数（需设置CHATWORK_API_TOKEN环境变量）
    "roomId": "",  // Chatwork房间ID
    "message": ""  // 通知消息内容
  },
  "tasks": {
    "runner": {},  // [必填] 运行器任务属性
    "reporter": {}  // 报告器任务属性
  }
}

核心参数说明：

• taskDefs.runner/taskDefs.reporter (TaskDef)：任务定义配置

  json
  {
    "stackName": "",  // [必填] CloudFormation堆栈名称
    "taskName": ""    // [必填] 堆栈输出中的任务定义名称
  }
  

• tasks.runner/tasks.reporter (TaskProp)：任务执行属性

  json
  {
    "executionIdEnvName": "",  // [报告器必填] 容器中使用execution_id的环境变量名
    "count": 1,                // 任务实例数量
    "environment": {}          // 环境变量键值对
  }
  

使用方法示例

基本使用

sh
# 使用IAM凭证
$ docker run -it --rm \
  -v ~/.aws/credentials:/root/.aws/credentials:ro \
  -v "$PWD"/gatlingEcs.json:/usr/src/app/setting.json \
  chatwork/gatling-ecs-client:0.1.2

# 使用SSO认证
$ aws sso login
$ docker run -it --rm \
  -v ~/.aws:/root/.aws:ro \
  -v "$PWD"/gatlingEcs.json:/usr/src/app/setting.json \
  chatwork/gatling-ecs-client:0.1.2

指定AWS配置文件

sh
# 使用IAM凭证与特定配置文件
$ docker run -it --rm \
  -e AWS_PROFILE="xxxxxxx" \
  -v ~/.aws/credentials:/root/.aws/credentials:ro \
  -v "$PWD"/gatlingEcs.json:/usr/src/app/setting.json \
  chatwork/gatling-ecs-client:0.1.2

# 使用SSO与特定配置文件
$ aws sso login --profile "xxxxxxx"
$ docker run -it --rm \
  -e AWS_PROFILE="xxxxxxx" \
  -v ~/.aws:/root/.aws:ro \
  -v "$PWD"/gatlingEcs.json:/usr/src/app/setting.json \
  chatwork/gatling-ecs-client:0.1.2

启用Chatwork通知

sh
$ export CHATWORK_API_TOKEN=xxxxxxxxxxxxxxxxxxx

# 使用IAM凭证与Chatwork通知
$ docker run -it --rm \
  -e AWS_PROFILE="xxxxxxx" \
  -e CHATWORK_API_TOKEN \
  -v ~/.aws/credentials:/root/.aws/credentials:ro \
  -v "$PWD"/gatlingEcs.json:/usr/src/app/setting.json \
  chatwork/gatling-ecs-client:0.1.2

# 使用SSO与Chatwork通知
$ aws sso login --profile "xxxxxxx"
$ docker run -it --rm \
  -e AWS_PROFILE="xxxxxxx" \
  -e CHATWORK_API_TOKEN \
  -v ~/.aws:/root/.aws:ro \
  -v "$PWD"/gatlingEcs.json:/usr/src/app/setting.json \
  chatwork/gatling-ecs-client:0.1.2