chatwork/gatling-s3-reporter

Gatling S3 Reporter Docker镜像文档

概述

Gatling S3 Reporter是一个用于从Gatling日志生成报告页面的Docker镜像。它能够读取存储在Amazon S3指定目录中的Gatling日志文件（文件名格式为*.log），并在日志所在的S3目录中生成可视化报告页面。该镜像适用于Gatling性能测试后，需要将日志转换为可读性强的报告的场景。

核心功能和特性

• 日志读取：支持从Amazon S3存储桶的指定目录读取Gatling日志文件（*.log格式）
• 报告生成：自动将日志转换为可视化报告页面，并存储在日志所在的S3目录中
• AWS认证支持：兼容多种AWS认证方式，包括基本凭证、AWS Profile和AWS SSO

使用场景

适用于Gatling性能测试完成后，日志文件已上传至Amazon S3存储桶，需要快速生成可视化测试报告的场景。特别是在CI/CD流程或分布式测试环境中，可通过Docker容器化方式便捷地生成和查看测试报告。

使用方法和配置说明

环境变量说明

使用示例

基本使用示例

通过挂载本地AWS凭证文件，从S3读取日志并生成报告：

bash
docker run -it --rm \
  -v ~/.aws/credentials:/root/.aws/credentials:ro \
  -e S3_GATLING_BUCKET_NAME=[s3存储桶名称] \
  -e S3_GATLING_RESULT_DIR_PATH=[s3目录路径] \
  chatwork/gatling-s3-reporter:latest

说明：-v ~/.aws/credentials:/root/.aws/credentials:ro 挂载本地AWS凭证文件，ro表示只读权限。

指定AWS Profile使用

当需要使用AWS凭证文件中的特定Profile时：

bash
docker run -it --rm \
  -v ~/.aws/credentials:/root/.aws/credentials:ro \
  -e S3_GATLING_BUCKET_NAME=[s3存储桶名称] \
  -e S3_GATLING_RESULT_DIR_PATH=[s3目录路径] \
  -e AWS_PROFILE=[profile名称] \
  chatwork/gatling-s3-reporter:latest

说明：AWS_PROFILE指定凭证文件中配置的Profile名称，用于多账户或多环境认证。

本地环境使用AWS SSO Profile

通过AWS SSO登录后使用SSO Profile：

bash
# 1. 本地通过SSO登录
aws sso login --profile [profile名称]

# 2. 运行容器，挂载完整AWS配置目录
docker run -it --rm \
  -e AWS_PROFILE=[profile名称] \
  -v ~/.aws:/root/.aws \
  -e S3_GATLING_BUCKET_NAME=[s3存储桶名称] \
  -e S3_GATLING_RESULT_DIR_PATH=[s3目录路径] \
  chatwork/gatling-s3-reporter:latest

说明：-v ~/.aws:/root/.aws 挂载完整AWS配置目录（包含SSO凭证），而非仅挂载credentials文件。