opensearch-devops icon indicating copy to clipboard operation
opensearch-devops copied to clipboard

Performance Benchmark Rest Apis

Open rishabh6788 opened this issue 1 year ago • 2 comments

Description

This PR introduces following rest apis to help opensource opensearch-project contributors submit ad-hoc benchmark runs on our jenkins infra. They do not need to log-in to the jenkins to submit the job as long as they are authorized using github teams.

  • submitBenchmarkRun: Rest api to submit ad-hoc benchmark using artifact tarball. Will re-use jenkin's benchmark-pull-request job to run benchmark.
  • submitBenchmarkEndpointRun: Rest api to submit ad-hoc benchmark against user's cluster endpoint. Will use benchmark-test-endpoint to run benchmark.

See detailed design in https://github.com/opensearch-project/opensearch-build/issues/4231

Issues Resolved

https://github.com/opensearch-project/opensearch-build/issues/4788

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.

rishabh6788 avatar Sep 03 '24 18:09 rishabh6788

@peterzhuamazon @gaiksaya Please provide review comments and feedback whenever you can.

rishabh6788 avatar Sep 12 '24 05:09 rishabh6788

Generally good on the 1st pass.

In offline conversation, I raise the question of having a limit set in API Gateway so that to prevent potential spamming on the API calls.

Thanks.

Added throttling rule to api.

rishabh6788 avatar Nov 12 '24 21:11 rishabh6788