opensearchproject/opensearch-benchmark

OpenSearch-Benchmark Docker镜像文档

1. 镜像概述与主要用途

OpenSearch-Benchmark是OpenSearch官方提供的宏基准测试框架，专为评估OpenSearch集群性能而设计。该工具能够自动化执行基准测试、记录关键性能指标、比较不同场景下的性能结果，并支持测试环境的自动部署与清理，为OpenSearch集群的性能优化、版本升级验证及配置调优提供标准化的测试能力。

2. 核心功能与特性

• 基准测试执行：支持运行预设或自定义工作负载，模拟真实业务场景下的集群负载（如索引创建、文档写入、查询执行等）。
• 性能指标记录：自动采集并记录吞吐量、延迟（平均/95分位/99分位）、资源利用率等关键性能数据，生成结构化结果报告。
• 多场景性能对比：支持对比不同OpenSearch版本、集群配置（节点数量、硬件资源、参数设置）或工作负载下的性能差异，识别性能变化趋势。
• 集群生命周期管理：集成集群自动部署与拆除功能，可快速搭建独立测试环境，并在测试结束后清理资源，降低环境准备成本。

3. 使用场景与适用范围

OpenSearch-Benchmark适用于以下场景：

• 性能基准测试：为OpenSearch集群建立性能基准线，评估集群在不同负载下的极限能力。
• 版本升级验证：对比升级前后的集群性能，验证新版本是否引入性能退化或提升。
• 配置优化评估：测试不同集群配置（如JVM参数、分片数量、副本策略）对性能的影响，辅助优化决策。
• 自定义工作负载测试：针对特定业务场景（如日志 ingestion、全文检索）编写自定义工作负载，评估集群适配性。

4. 使用方法与配置说明

4.1 拉取镜像

通过Docker Hub拉取官方镜像，支持指定版本标签（如latest或具体版本号）：

bash
# 拉取最新版本
docker pull opensearchproject/opensearch-benchmark:latest

# 拉取指定版本（示例：2.11.0）
docker pull opensearchproject/opensearch-benchmark:2.11.0

所有可用版本标签可参考https://hub.docker.com/r/opensearchproject/opensearch-benchmark/tags%E3%80%82

4.2 运行容器

4.2.1 查看帮助信息

通过-h参数查看命令行工具的完整使用说明：

bash
docker run --rm opensearchproject/opensearch-benchmark -h

4.2.2 基本测试示例

以下示例展示如何对目标OpenSearch集群执行基准测试（需替换集群地址、认证信息等参数）：

bash
docker run --rm opensearchproject/opensearch-benchmark execute-test \
  --target-hosts https://opensearch-cluster:9200 \  # 目标集群地址（多个节点用逗号分隔）
  --workload=geonames \                             # 预设工作负载（如geonames、nyc_taxis）
  --indices=1 \                                     # 索引数量
  --clients=8 \                                     # 并发客户端数量
  --username=admin \                                # 集群认证用户名（若启用安全配置）
  --password=admin \                                # 集群认证密码（若启用安全配置）
  --ssl-certificate-verification=false              # 禁用SSL证书验证（测试环境用）

注：若目标集群运行在宿主机，可通过host.docker.internal访问（如http://host.docker.internal:9200）；生产环境需启用SSL证书验证并提供有效证书路径。

4.3 高级配置

OpenSearch-Benchmark支持通过命令行参数或配置文件自定义测试行为，详细参数可参考https://github.com/opensearch-project/opensearch-benchmark/tree/main/docker%E3%80%82%E5%85%B8%E5%9E%8B%E9%AB%98%E7%BA%A7%E5%9C%BA%E6%99%AF%E5%8C%85%E6%8B%AC%EF%BC%9A

• 自定义工作负载文件挂载：通过-v参数挂载本地工作负载目录（如-v /local/workloads:/benchmark/workloads）。
• 结果存储配置：指定结果输出路径或集成Elasticsearch存储测试报告（通过--results-format和--results-directory参数）。

5. 维护与支持

• 维护主体：由https://github.com/opensearch-project%E5%AE%98%E6%96%B9%E7%BB%B4%E6%8A%A4%E3%80%82
• 社区支持：通过官方社区论坛提问或参与讨论，获取使用帮助。
• 问题反馈：若遇到镜像构建或Docker相关问题，可通过https://github.com/opensearch-project/opensearch-build/issues%E6%8F%90%E4%BA%A4%E6%8A%A5%E5%91%8A%E3%80%82

6. 许可信息

OpenSearch-Benchmark基于Apache License, Version 2.0开源许可协议发布，允许自由使用、修改和分发。

7. 贡献方式

OpenSearch项目坚持100%开源，欢迎社区贡献代码、文档或反馈。贡献者无需签署复杂协议，可直接通过GitHub提交PR或参与讨论。更多信息请访问OpenSearch官方网站。