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

[SBK-314] Add REST API for command/control/monitoring #39

Open
fubuloubu opened this issue Oct 11, 2023 · 0 comments
Open

[SBK-314] Add REST API for command/control/monitoring #39

fubuloubu opened this issue Oct 11, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@fubuloubu
Copy link
Member

fubuloubu commented Oct 11, 2023

Overview

When running an app, often it would be very useful to have some basic C&C capabilities, including being able to monitor the results of the tasks as they are running, and the failure rate (among other things). It also would be really handy to be able to restart/stop the bot in case the user decides the bot is not working as intented. Lastly, a really cool feature would be the ability to adjust parameters of the bot's execution as you are running live, such as things like filter parameters, limits, and more

Specification

Integrate a FastAPI app into the SilverbackApp class. Expose ends points for being able to query the TaskIQ task queue status (jobs in progress, failures/successes, etc) and results backend (if one is configured). Allow the ability for users to add their own custom endpoints for command/control inputs into the bot.

Consider adding a default control panel (built with Textualize) that can be extended by end users (as a demo for what we will build ourselves for the platform, as well as allows easier local development)

Dependencies

SPIKE needed to identify the proper way to secure the REST API (specifically C&C inputs) for exposure to cloud services, as well as best way to integrate into metrics gathering platforms

SBK-314

@fubuloubu fubuloubu added the enhancement New feature or request label Oct 11, 2023
@fubuloubu fubuloubu changed the title Add REST API for command/control/monitoring [SBK-314] Add REST API for command/control/monitoring Oct 11, 2023
This was referenced Mar 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant