Benchmark API to compare stream with regular transport

[rishabhmaurya]

Description

I found this API to be extremely helpful in comparing performance with regular transport and surfacing issues. Thus, pushing them as part of stream-transport-example plugin.

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

Check List

• Functionality includes testing.
• API changes companion pull request created, if applicable.
• Public documentation issue/PR created, if applicable.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[coderabbitai]

Warning

Rate limit exceeded

@rishabhmaurya has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 2 minutes and 8 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 14c60a0 and f6f9c41.

📒 Files selected for processing (13)

• plugins/examples/stream-transport-example/BENCHMARK.md
• plugins/examples/stream-transport-example/README.md
• plugins/examples/stream-transport-example/src/internalClusterTest/java/org/opensearch/example/stream/StreamTransportExampleIT.java
• plugins/examples/stream-transport-example/src/internalClusterTest/java/org/opensearch/example/stream/benchmark/BenchmarkStreamIT.java
• plugins/examples/stream-transport-example/src/main/java/org/opensearch/example/stream/StreamTransportExamplePlugin.java
• plugins/examples/stream-transport-example/src/main/java/org/opensearch/example/stream/TransportStreamDataAction.java
• plugins/examples/stream-transport-example/src/main/java/org/opensearch/example/stream/benchmark/BenchmarkDataResponse.java
• plugins/examples/stream-transport-example/src/main/java/org/opensearch/example/stream/benchmark/BenchmarkStreamAction.java
• plugins/examples/stream-transport-example/src/main/java/org/opensearch/example/stream/benchmark/BenchmarkStreamRequest.java
• plugins/examples/stream-transport-example/src/main/java/org/opensearch/example/stream/benchmark/BenchmarkStreamResponse.java
• plugins/examples/stream-transport-example/src/main/java/org/opensearch/example/stream/benchmark/RestBenchmarkStreamAction.java
• plugins/examples/stream-transport-example/src/main/java/org/opensearch/example/stream/benchmark/TransportBenchmarkStreamAction.java
• plugins/examples/stream-transport-example/src/main/java/org/opensearch/example/stream/benchmark/package-info.java

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

❌ Gradle check result for f6f9c41: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?