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

ci: add additional verification tweak concurrent users performance testing #2425

Conversation

gzukel
Copy link
Contributor

@gzukel gzukel commented Jul 3, 2024

Description

  • Added verification to performance testing pipeline to ensure p99 aren't above 2000ms and p50 aren't above 40ms
  • Tweaked the config to 400 users requests per second. 425 is the current max before it starts failing.

How Has This Been Tested?

https://github.com/zeta-chain/node/actions/runs/9772131099

  • Tested CCTX in localnet
  • Tested in development environment
  • Go unit tests
  • Go integration tests
  • Tested via GitHub Actions

Summary by CodeRabbit

  • Chores
    • Updated performance test configurations and parameters for more accurate load testing.
    • Enhanced nightly performance testing workflow with optional endpoint input, improved test result validation, and stricter performance thresholds (p99 < 2000ms, p50 < 40ms, up to 400 user req/sec).

@gzukel gzukel requested a review from a team as a code owner July 3, 2024 14:04
Copy link
Contributor

coderabbitai bot commented Jul 3, 2024

Walkthrough

The recent updates enhance the performance testing pipeline for EVM endpoints by configuring flexible URL placeholders and increasing load testing parameters. The nightly CI workflow now accepts an optional endpoint for testing, executes performance tests, and validates results against set thresholds.

Changes

File Path Summary
.github/actions/performance-tests/art.yaml Updated to use placeholders for protocol and endpoint in target URL; increased load testing duration and rate.
.github/workflows/ci-nightly-performance-testing.yaml Added optional EVM endpoint input, environment variable configuration, performance test execution, and result validation steps.
changelog.md Documented the addition of performance test verification to ensure p99 below 2000ms and p50 below 40ms, with configurations for up to 400 requests/sec.

Poem

In the world of code, the tests now rise,
With endpoints flexible, under starry skies.
Load increased, performance in sight,
Nightly runs ensure the metrics are right.
Happy nodes, swift as can be,
Endpoints tested, from sea to shining sea. 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the ci Changes to CI pipeline or github actions label Jul 3, 2024
Copy link
Contributor

@CryptoFewka CryptoFewka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@CryptoFewka CryptoFewka enabled auto-merge July 10, 2024 15:05
@gartnera gartnera force-pushed the ci-add-additional-verification-tweak-concurrent-users-performance-testing branch from ec4ce6b to ff5a486 Compare July 10, 2024 15:57
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b602ded and ff5a486.

Files selected for processing (3)
  • .github/actions/performance-tests/art.yaml (2 hunks)
  • .github/workflows/ci-nightly-performance-testing.yaml (3 hunks)
  • changelog.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/actions/performance-tests/art.yaml
Additional comments not posted (6)
.github/workflows/ci-nightly-performance-testing.yaml (5)

5-9: Input handling changes approved.

The new inputs for specifying the EVM endpoint are correctly added and provide flexibility for configuring performance tests dynamically.


17-18: Environment variable setup changes approved.

The environment variable endpoint_to_test is correctly set to a default value, ensuring that the endpoint is properly configured for testing.


35-72: Performance template configuration changes approved with a minor optimization suggestion.

The logic for configuring the performance template based on the provided endpoint is well-implemented and handles different scenarios correctly.

Optimization Suggestion:

The logic for stripping the protocol can be optimized to avoid repeated code.

-  endpoint_to_test=${endpoint_to_test#http://}
-  endpoint_to_test=${endpoint_to_test#https://}
+  endpoint_to_test=$(echo $endpoint_to_test | sed -E 's#^(http://|https://)##')

[approved, refactor_suggestion]


76-81: Performance test execution changes approved.

The step to execute performance tests using Artillery is correctly set up, ensuring that the tests are run with the specified configuration and the results are output to a JSON file.


Line range hint 82-120:
Test results validation changes approved.

The changes to validate test results, including checking for failed tests, HTTP response codes, and validating P99 and P50 values against predefined thresholds, ensure that performance metrics meet the required standards.

changelog.md (1)

105-105: Changelog entry approved.

The entry correctly documents the addition of verification steps in the performance testing pipeline and the configuration tweaks to handle 400 user requests per second.

@CryptoFewka CryptoFewka added this pull request to the merge queue Jul 10, 2024
Merged via the queue into develop with commit 7e1dd53 Jul 10, 2024
27 of 30 checks passed
@CryptoFewka CryptoFewka deleted the ci-add-additional-verification-tweak-concurrent-users-performance-testing branch July 10, 2024 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Changes to CI pipeline or github actions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants