search

pokt-network / poktroll

The official Shannon upgrade implementation of the Pocket Network Protocol implemented using the Cosmos SDK
MIT License
15 stars 8 forks source link

[Documentation] Load Testing on DevNets and TestNets #637

Closed okdas closed 3 months ago

okdas commented 4 months ago

Summary

Documents Load Testing on DevNet (and some TestNet?)

Issue

Type of change

Select one or more:

Testing

Documentation changes (only if making doc changes)

Local Testing (only if making code changes)

PR Testing (only if making code changes)

Sanity Checklist

Summary by CodeRabbit

okdas commented 4 months ago

Hey @red-0ne - here are some updated load test documentation pages. Would you mind taking a look? Thank you!

okdas commented 4 months ago

@red-0ne actually had a chat with @bryanchriswhite - he'll take a look at this PR. You've got so many other PRs to review at this point! :)

coderabbitai[bot] commented 3 months ago

Walkthrough

The update enhances documentation and scripts for DevNets, TestNets, and load testing. New sections in DevNet and load testing guides detail manual provisioning, configuration, scaling, and testing. Changes also involve updates to scripts and manifests, emphasizing the shift from k6 to Gherkin for load testing, and refining how custom manifest files are handled in the Makefile.

Changes

Files Change Summaries
.gitignore, Makefile Added job.yaml to .gitignore. Renamed test_load_relays_stress_example to test_load_relays_stress_custom in Makefile, allowing custom manifest specification with LOAD_TEST_CUSTOM_MANIFEST.
.../docs/operate/...devnet.md, ...devnet_testing.md Expanded DevNet guide, adding sections on interaction, types, manual provisioning, scaling actors, and running e2e tests. Introduced a comprehensive load testing guide for DevNets.
.../docs/operate/...load_testing.md, ...testnet.md Reorganized load testing documentation, introducing Gherkin over k6 for test scripting. Provided a guide for load testing on TestNets, detailing necessary considerations and steps.
.../loadtest_manifest_example.yaml, ...localnet.yaml Modified URLs, service IDs, account addresses, and gateway configurations within example load-test manifest files. Added comments to clarify is_ephemeral_chain and ensure alignment in LocalNet.

Sequence Diagram(s)

N/A

Poem

In the realm of DevNets and TestNets, Where actors and scripts blend like sunsets, Docs updated, guides so grand, Gherkin leads, we understand. Custom manifests now take their stand, Scaling heights upon command.

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
okdas commented 3 months ago

Thank you, @bryanchriswhite. As always — amazing feedback! I addressed most of your points, and have a couple to take care of left. I'll request a review tomorrow once they're taken care of.

okdas commented 3 months ago

@bryanchriswhite all feedback has been addressed now. Thank you! :)