Skip to content

docs: JSON-RPC response streaming for traces and logs - #362

Merged
svlachakis merged 1 commit into
mainfrom
docs/rpc-streaming
Sep 11, 2026
Merged

svlachakis merged 1 commit into
mainfrom
docs/rpc-streaming

Conversation

@svlachakis

Copy link
Copy Markdown
Contributor

What

Documents JSON-RPC response streaming, which shipped in 1.39.0 and had no prose anywhere: a new Streaming responses section 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

  • What streaming is for: a response far larger than the request that asked for it is written to the transport as it is produced, so the memory a request costs is bounded by the stream rather than by the size of its result, and the first bytes arrive before the work finishes.
  • Traces: JsonRpc.EnableTracingStreamMode, on by default, with the per-call streamMode override on debug_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.
  • Logs: 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* and ArchiveProof* ones, which appear when the reference is regenerated for 2.0).

@svlachakis
svlachakis merged commit 623e02a into main Sep 11, 2026
1 check passed
@svlachakis
svlachakis deleted the docs/rpc-streaming branch September 11, 2026 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants