[DRAFT][ereport] Initial draft of ereport reporter API #6835
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hawkw
force-pushed
the
eliza/ereporter
branch
from
a9683c7 to
4a170d7
Compare
thanks @cbiffle for the suggestion
hawkw
added a commit
that referenced
this pull request
Mar 26, 2025
This branch adds an initial version of the HTTP API for the control plane's ereport ingestion mechanism, as described in [RFD 520]. In particularr, this branch adds the following: - an `ereport-types` crate, containing the shared type definitions for ereport data - an `ereporter-api` crate defining the Dropshot HTTP API that will be implemented by MGS and sled-agents in order to expose ereports to Nexus - the generated `ereporter-client` crate for that API, which Nexus will use to ingest ereports from reporters. Actually implementing the API in MGS and sled-agent, and implementing the Nexus RPW for collecting ereports using this interface, is left as an exercise for ~~the reader~~ future Eliza. I also intend to add a simulated version of this API to the simulated sled-agent and MGS, to to use for testing the ingestion bits in Nexus. The ereporter HTTP API has changed a bit from the strawman version proposed in RFD 520, as the request to collect new ereports and the request to flush already-committed ereports are now contained in the same HTTP request, rather than requiring separate endpoints for these operations. This is due to @cbiffle: in [his proposal][545-4.4.1] for the MGS-to-SP hop in the ereport pipeline in [RFD 545], Cliff has combined these into one message, which I thought seemed nice to do here as well. Closes #6835 (obsoleted by this change) [RFD 520]: https://rfd.shared.oxide.computer/rfd/520 [RFD 545]: https://rfd.shared.oxide.computer/rfd/0545 [545-4.4.1]: https://rfd.shared.oxide.computer/rfd/0545#_mgs_interface
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an initial draft of the reporter API for error reports (ereports), as described in RFD 520's determinations. This is not a complete implementation and isn't ready to merge yet.