oxidecomputer / oxidecomputer/omicron

Feature Request: Configurable retention policy for serial console output buffer of an instance

Open
#6,088 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 12h
Merged PRs (30d)
96

Description

It would be useful to retain and access the scrollback buffer of an instance's serial console at arbitrary times, regardless of an instance's state (e.g. if it goes into Stopped or Failed deliberately or otherwise).
This applies both for omicron development (e.g. debugging a guest crash while making changes to propolis) and for users who simply encounter a bug in their own guest OS / application (e.g. reviewing a kernel panic written only to the tty). Even outside of these circumstances, it can sometimes be useful to retain logs as part of a security policy or simply for historical/informational purposes.

Feature Request:

  • Allow a user to decide whether the buffer should be cleared upon an instance stop vs an instance delete, and to choose a max size on the buffer (presumably in lines or bytes).
  • Allow the buffer to be retrieved regardless of instance state.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by tracing the existing serial-console buffer behavior and the instance stop and delete lifecycle paths, then identify the API surfaces for configuring retention and retrieving output; done means retention choices and retrieval work in every requested instance state.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.