oxidecomputer / oxidecomputer/omicron

umbrella: notifications on crash dump savecore

Open
#4,293 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Debugging mvp Sled Agent
Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 12h
Merged PRs (30d)
96

Description

There are a number of umbrella and individual tickets covering collection and management of data used to debug problems with the machine and our software. A few examples of these are #2235, #2478, and #3860. The general premise of these tickets is that when a crash (of a sled, or of component user software) occurs, we will preserve data that may be useful in understanding the cause.

This ticket covers notifying Oxide (or in principle a third-party support provider) that such an event has occurred and data is, or should be, available for retrieval. A simpler and more universal aspect of this is notifying operators; notifications of events like these is discussed in RFDs 55 and 307; while the latter was clearly intended to cover functionality available at RR, I'm unaware of any current means by which an operator can be notified when a sled has crashed and rebooted with a dump saved. The operator should also be able to query via API the state of debug data availability of each sled or a specific sled, or the entire machine, as well as some crash event history. There is probably also scope here for detection of sleds that are not functioning at all, tying in with #4287 and reporting this as an event even if no automated action is taken as a matter of policy. Consider RFDs 82 and 302 here.

This is another umbrella ticket that covers what is essentially project-scope work. Additional tickets for specific pieces are likely to be desirable.

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

Start by reviewing RFDs 55, 307, 82, and 302, then read related issues #2235, #2478, #3860, and #4287. Define the project scope for crash and nonfunctioning-sled events, operator and support notifications, debug-data availability queries, and crash history before splitting this umbrella ticket into specific work.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.