Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sequencer Benchmark Scripts Improvement and Documentation #2422

Merged
merged 6 commits into from
Aug 30, 2023

Conversation

Psykepro
Copy link
Contributor

Closes #2417.

What does this PR do?

This pull request introduces several improvements to the benchmark scripts. These improvements aim to streamline the process of collecting metrics from a remote server, calculating various statistics, and presenting the results in a more readable format.

Main changes:

  1. Improvements in workflow:

    • Added a new main.go script that automates several tasks related to benchmarking.
    • This script handles all additional steps needed to collect metrics from a remote server, perform calculations, and print the results.
  2. Enhancements in Result Printing:

    • The format of the printed results has been significantly improved, making it more user-friendly and easier to read.
    • Added new output formats for presenting benchmark results.
  3. Documentation:

    • Updated the documentation README.md to provide clear instructions on how to use the benchmark scripts.
    • Added detailed explanations of the benchmarking process and how to interpret the results.

Impact:

These changes will simplify the benchmarking process, making it easier for developers to collect performance metrics and analyze the results. Additionally, the updated documentation will provide valuable guidance for users who are new to the benchmarking process.

Reviewers

@Psykepro Psykepro added documentation Improvements or additions to documentation sequencer improvement benchmark test labels Aug 18, 2023
@Psykepro Psykepro added this to the v0.3.0 milestone Aug 18, 2023
@Psykepro Psykepro requested a review from tclemos as a code owner August 18, 2023 13:23
@Psykepro Psykepro self-assigned this Aug 18, 2023
@cla-bot cla-bot bot added the cla-signed label Aug 18, 2023
@Psykepro Psykepro force-pushed the docs/benchmark-scripts-how-to branch from c346219 to 593d356 Compare August 18, 2023 14:22
…teps for setup, metrics collection and printing, and adding docs.

Signed-off-by: Nikolay Nedkov <[email protected]>
@Psykepro Psykepro force-pushed the docs/benchmark-scripts-how-to branch from 593d356 to a5b55a7 Compare August 18, 2023 14:36
@Psykepro Psykepro requested a review from agnusmor as a code owner August 24, 2023 09:14
@Psykepro Psykepro force-pushed the docs/benchmark-scripts-how-to branch from c4c16b7 to 12e7228 Compare August 24, 2023 09:27
@Psykepro Psykepro force-pushed the docs/benchmark-scripts-how-to branch from 9d4a55b to e5faf3e Compare August 29, 2023 13:29
@Psykepro Psykepro merged commit 710c364 into develop Aug 30, 2023
@Psykepro Psykepro deleted the docs/benchmark-scripts-how-to branch August 30, 2023 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create documentation for running benchmark scripts
3 participants