Make invalid states (more) representable #10
Merged
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
Currently, the `AntagonistError` type has some errors that wrap other values, but don't format those values when displayed. This is kind of unfortunate. For example: ``` 2024-10-23T21:01:34.795972Z ERROR omicron_stress: 202: invalid actor state 2024-10-23T21:01:34.796049Z INFO omicron_stress: 218: Halting actors ``` Seeing this in my logs felt kind of painful, because it's like, "okay, what was the invalid state?" and there's no way to find out what it was. It turns out that there's a string that's in there which says what the invalid state was, but it didn't get formatted in the `Display` impl, and now the process has exited, so which invalid state occurred has been permanently lost to the sands of time. After this change, it now looks like this: ``` 2024-10-23T21:25:17.983062Z ERROR omicron_stress: 202: invalid actor state: instance inst1 unexpectedly in state Failed 2024-10-23T21:25:17.983160Z INFO omicron_stress: 218: Halting actors ``` If you compare this with the output from before, you will notice that I have made invalid states representable. In this case, that's actually a good thing.
|
See also oxidecomputer/omicron#6913 (comment) for a record of my mental anguish upon discovering this. |
gjcolombo
approved these changes
Oct 24, 2024
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.
Currently, the
AntagonistErrortype has some errors that wrap othervalues, but don't format those values when displayed. This is kind of
unfortunate. For example:
Seeing this in my logs felt kind of painful, because it's like, "okay,
what was the invalid state?" and there's no way to find out what it was.
It turns out that there's a string that's in there which says what the
invalid state was, but it didn't get formatted in the
Displayimpl,and now the process has exited, so which invalid state occurred has been
permanently lost to the sands of time.
After this change, it now looks like this:
If you compare this with the output from before, you will notice that I
have made invalid states representable. In this case, that's actually a
good thing.