salesforce / best

:trophy: Delightful Benchmarking & Performance Testing
https://opensource.salesforce.com/best
MIT License
95 stars 10 forks source link

feat: add rest APIs for agent info to the hub #308

Closed dbajric closed 2 years ago

dbajric commented 2 years ago

Details

Currently, the Hub exposes agent info via a WebSocket transport and renders it as HTML in the browser. While it works great for this scenario, it is less desirable for external callers where they are mostly interested in point-in-time state of agents. For example, in order to integrate Best with auto-scaling functionality in AWS (or other cloud providers), simple stateless REST endpoints provide an easier integration option, therefore I opened this PR.

Does this PR introduce a breaking change?

diervo commented 2 years ago

@dbajric FYI the hub or agent had a WebSocket API already open, probably a stateless REST makes sense too, but just in case you need a more real-time approach. :)

dbajric commented 2 years ago

@diervo - Yes, WebSocket works great for the existing scenarios. Where it is a bit less desirable is as we are integrating Best with AWS' auto-scaling functionality and REST endpoints are just easier to use here.