Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 3.86 KB

README_ZH.MD

File metadata and controls

87 lines (59 loc) · 3.86 KB

Probe

Build Status

Probe是什么

Probe 根据性能测试白皮书, Probe是一个面向Hyperledger Fabric维护者，用户，研究者的web UI的应用程序，短期而言旨在提供控制被测网络（SUT）并协调压力生成工具于观察工具，来针对性的观察Fabric出块参数对于Fabric网络性能的影响。

  • 提供循环测试控制。
  • 提供可视化的结果对比图。
  • 提供基于test-network的配置案例。

长期而言Probe计划扮演一个协调者的工作

  • Probe将允许您设计shell脚本来调度SUT和测试工具。
  • Probe将允许您以自定义的方式使用GUI来可视化性能指标和配置之间的关系。

可以用Probe做什么

为什么使用Probe

Probe是在TWGC performance work group的交流中中，我们对于“如何配置出块参数来达到最大tps？”这一问题的回答而创立并实现的项目。

Probe不做什么

  • 实时监控，如需要，请参考配置Prometheus
  • 完整的自动测试框架，对于SUT的部署方式，目前依赖于test-network
  • 性能测试工具（LGC），对于性能测试本身，目前依赖于Tape
  • Tape的GUI版本

快速上手

  1. 安装项目 npm install

  2. 安装fabric-sample环境

    curl -vsS https://raw.githubusercontent.com/hyperledger/fabric/master/scripts/bootstrap.sh | bash

    【注】

    如果上述curl命令执行失败，这可能是由于部分国家或地区的网络原因导致curl的ssl握手失败。 在这种情况下，我们建议用户手工下载bootstrap.sh脚本和运行。

  3. 下载tape的dockeer版本 docker pull ghcr.io/hyperledger-twgc/tape

  4. 将参数控制脚本通过以下命令安装 cp sample/prepareConfig.sh fabric-samples/test-network

  5. 启动Probe npm start

  6. 打开localhost:3000, 点击TestNetworkSample

  7. 点击submit

  8. 待完成后访问 localhost:3000/result/BatchTimeout 查看TPS与BatchTimeout之间的关系

  9. 待完成后访问 localhost:3000/result/MaxMessageCount 查看TPS与MaxMessageCount之间的关系

维护和升级计划

version define feature
0.0.4 customer UI enhancement allow user chose parameters to show on UI
0.0.5 support different deploy plan with peers 4/5 6/3 8/1
0.0.6 support different deploy plan with orgs 2 3 4
0.0.7 support different deploy plan with gossip 1:1 1:2 1:3
0.0.8 support different deploy plan with mvcc 10 20 40
0.0.9 support different deploy plan with data size 10k 512k 1M
1.0.0 fix up bugs after 0.0.4
1.1.x tools supporting supports caliper
1.2.x network starter supporting supports cello

如何贡献

如果您想为 Probe 添加新的特性，或者修复 bug，非常欢迎您在创建 issue，当然，如果能提交 PR 会更好。

如果您希望贡献文档翻译，或者学习教程，也欢迎和我们联系。

对于研发，请先参考快速上手完成环境配置。

请使用npm run build来开发前台。

请使用--DryRun来通过mock的方式开发后台功能，但是请把实际测试案例加入CI。

学习视频

version URL comments
0.0.1 https://www.bilibili.com/video/BV1x54y1x78Z N/A
0.0.1 https://www.bilibili.com/video/BV1dV411y7oZ N/A
0.0.2 https://www.bilibili.com/video/bv13t4y1B7AE N/A
0.0.3 https://www.bilibili.com/video/BV1Kz4y1179L N/A