v0.1.1

General release information

This is a PATCH release which fixes some bugs discovered recently and introduces some huge improvements while running benchmarks on mainnet.

Bugs fixed by this release:

• reporter and monitor-traffic-tcpdump containers are not running on apple M2 pro #48
• Dig into current stratum urls used to compute latency and optimize the process #67
• monitor-and-apply-latency.sh script is not working on ubuntu #68
• PDF reports cannot be generated due to time format error #69

Major improvements added by this release:

• Enhanced UX while using the tool on mainnet #50
• Improved docker images builders sizes #62
• CI introduction to test every PR opened against main branch #41

What's Changed

• Add workflow file by @Shourya742 in #41
• Fix ci by @Shourya742 in #44
• Make template provider dockerfile arch agnostic by @Shourya742 in #46
• Maker service reporter and monitor-traffic-tcpdump platform specific by @Shourya742 in #49
• git hooks by @Shourya742 in #40
• fix-ci by @Shourya742 in #55
• Enhance nodes IBD by @GitGab19 in #50
• Removed unnecessary logs from proxies by @GitGab19 in #60
• Docker images optimization + docker-compose adjustment by @GitGab19 in #62
• correct misspelling by @average-gary in #56
• Add tool level logging for binaries by @Shourya742 in #65
• Fix monitor-and-apply-latency.sh by @Shourya742 in #71
• Improve run script by @GitGab19 in #75
• fix grafana version to 11.2.4 by @GitGab19 in #76
• average latency computation enhancement by @GitGab19 in #74

New Contributors

• @average-gary made their first contribution in #56

Full Changelog: 0.1.0...v0.1.1

0.1.0

Stratum V2 Benchmarking Tool - Version 0.1.0

Release Date: August 18, 2024

🚀 What's New

This is the initial release of the Stratum V2 Benchmarking Tool, version 0.1.0. It serves as a comprehensive solution for testing and comparing the performance of Stratum V1 and Stratum V2 protocols across various mining scenarios. Key features include:

• Comprehensive Testing Suite: Evaluate different SRI configurations with customizable role settings.
• Automated Benchmarking: Automatically generate and collect performance data for both Stratum V1 and Stratum V2.
• Detailed Reporting: Produce detailed reports that compare protocol performance with clear metrics and visualizations.

🛠 Known Issues

• Performance on Legacy Systems: The tool may exhibit suboptimal performance on older or less powerful hardware.
• SV1 context is missing a proxy to aggregate miners' connections: It will be added in the next release.

💡 What's Next

Future releases will focus on performance optimization, enhanced scalability, and expanded documentation to improve user experience and extend functionality.

📄 Report Analysis Guide

To effectively analyze the benchmarks generated by this tool, we recommend reviewing the Benchmarking Tool Overview. This document explains the tool's architecture, outlines the methodology for metrics collection, and provides guidelines for interpreting the results. It includes an initial benchmark with a detailed analysis, helping you draw meaningful conclusions from your benchmarking data.

🙏 Acknowledgements

A special thank you to all the contributors who helped make this release possible. Your dedication and hard work have been invaluable in bringing the Stratum V2 Benchmarking Tool to life. We look forward to your continued support and collaboration in future versions.
@Shourya742 @marathon-gary @pavlenex