oxidecomputer / oxidecomputer/propolis
add guest event log API
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 270
- Forks
- 42
- Avg merge
- 4d 5h
- Merged PRs (30d)
- 6
Description
It could be useful to add an API endpoint to propolis-server that exposes a stream of timestamped guest lifecycle events, such as "starting guest", "restarting guest", "guest crashed", et cetera. This data could be used for constructing a chronological log of an instance's history more easily than using Oximeter metrics or the stdout of the propolis-server process. Clients could subscribe to this endpoint via HTTP long-polling.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the propolis-server HTTP entry point and reviewing how guest lifecycle events are currently represented, alongside the existing Oximeter metrics and process stdout mentioned in the issue. Define the event stream and HTTP long-polling behavior before implementation. Done means clients can retrieve a chronological stream of timestamped guest lifecycle events.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100