docs: JSON-RPC response streaming for traces and logs - #362
Merged
Merged
Conversation
flcl42
approved these changes
Sep 11, 2026
damian-orzechowski
approved these changes
Sep 11, 2026
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
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.
What
Documents JSON-RPC response streaming, which shipped in 1.39.0 and had no prose anywhere: a new
Streaming responsessection on the JSON-RPC server page, with a subsection each for traces and logs.The two configuration options already appear in the generated configuration reference, but nothing told an operator what streaming does, that traces stream by default, or why the logs one is opt-in. Operators running 1.39 have the trace behaviour today without knowing it.
Content
JsonRpc.EnableTracingStreamMode, on by default, with the per-callstreamModeoverride ondebug_trace*and a Cast example. States plainly that streaming bounds memory and lowers time to first byte but does not make a trace faster, since tracing re-executes the block.JsonRpc.EnableLogsStreamMode, off by default, and the reason it is opt-in: a streamed response stops at the per-response limits instead of buffering the whole result and returning a limit error, and authenticated requests are not subject to those limits.Style
Behaviour only, no numbers; every option links to its entry in the generated configuration reference. All four anchors this section links to already exist there, so it adds no broken anchor (the build's remaining warnings are the pre-existing
FlatDb.History*andArchiveProof*ones, which appear when the reference is regenerated for 2.0).