docs(rfd): Add RFD D34 machine output envelope - #899
Merged
Conversation
Add RFD D34, which proposes wrapping every JSON machine record JP
emits in a `{format, version, data}` envelope so consumers can
detect what they received, plus a `--format-version` flag so they
can pin what they parse. Line-oriented ID formats keep their
current bytes and are versioned out-of-band only. Every existing
shape starts at version `0`, which promises nothing, so the
envelope can ship ahead of any shape being stabilized. The RFD
reserves exit codes `20` and `21` for a requested version being too
old or too new, respectively.
Cross-link the draft from RFD D15 and RFD D32, noting that D34
explicitly leaves the observability channel (trace events and the
log-path announcement) out of its registry, and that whether either
RFD's output later joins that registry is their call to make, not
D34's.
Signed-off-by: Jean Mertz <git@jeanmertz.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add RFD D34, which proposes wrapping every JSON machine record JP emits in a
{format, version, data}envelope so consumers can detect what they received, plus a--format-versionflag so they can pin what they parse. Line-oriented ID formats keep their current bytes and are versioned out-of-band only. Every existing shape starts at version0, which promises nothing, so the envelope can ship ahead of any shape being stabilized. The RFD reserves exit codes20and21for a requested version being too old or too new, respectively.Cross-link the draft from RFD D15 and RFD D32, noting that D34 explicitly leaves the observability channel (trace events and the log-path announcement) out of its registry, and that whether either RFD's output later joins that registry is their call to make, not D34's.