Skip to content

docs(rfd): Add RFD D34 machine output envelope #899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JeanMertz merged 1 commit into from
Jul 28, 2026
Merged

docs(rfd): Add RFD D34 machine output envelope #899

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/rfd/drafts/D15-structured-logging-infrastructure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,14 @@ lifecycle.
- **Structured log querying.** The JSON log files can be parsed with `jq`, but
this RFD does not add a `jp log` subcommand or similar.

> [!TIP]
> [RFD D34] wraps JP's machine-readable output in a versioned `{format, version,
> data}` envelope and explicitly leaves the observability channel out of it.
> Two seams are this RFD's to settle: whether the post-run log report's path
> line (today a bare `{"trace_log": "…"}` on stderr, which `.config/jp/tools`
> parses) becomes a versioned machine record, and whether stderr tracing output
> under `--log-format=json` earns a format address at all.

## Risks and Open Questions

### Buffer memory usage
Expand Down Expand Up @@ -289,3 +297,4 @@ Depends on Phase 2.
- `crates/jp_cli/src/session.rs` — session identity resolution.

[RFD 048]: ../048-four-channel-output-model.md
[RFD D34]: D34-versioned-machine-output-envelope.md
11 changes: 11 additions & 0 deletions docs/rfd/drafts/D32-jp-tracing-infrastructure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,6 +757,16 @@ Users familiar with `RUST_LOG` will recognize the format.
If metrics become needed, the `Emit` trait can be extended to emit metrics
alongside trace events.

> [!TIP]
> [RFD D34] versions JP's machine-readable output behind a `{format, version,
> data}` envelope, and excludes tracing on the grounds that JP does not today
> commit to the trace event shape.
> The typed events this RFD introduces change that premise: once trace events
> are JP-owned structs rather than `tracing-subscriber`'s serialization, whether
> they become versioned machine records with format addresses is this RFD's call
> to make.
> RFD D34 neither claims nor forecloses it.

## Risks and Open Questions

### Task-local recorder and `tokio::spawn`
Expand Down Expand Up @@ -896,3 +906,4 @@ Depends on Phase 1 and the chrome verbosity RFD.
[RFD 048]: ../048-four-channel-output-model.md
[RFD 072]: ../072-command-plugin-system.md
[RFD D15]: D15-structured-logging-infrastructure.md
[RFD D34]: D34-versioned-machine-output-envelope.md
Loading
Loading