Skip to content

starknet_transaction_prover: document existing logging, request ids and health probe in README - #14203

Merged
avi-starkware merged 1 commit into
main-v0.14.4from
avi/prover-v3/docs
Aug 25, 2026
Merged

starknet_transaction_prover: document existing logging, request ids and health probe in README#14203
avi-starkware merged 1 commit into
main-v0.14.4from
avi/prover-v3/docs

Conversation

@avi-starkware

Copy link
Copy Markdown
Collaborator

Adds a top-level Observability section to the README covering the
HTTP-only side endpoints (/health, /metrics), the metric names and
label sets, request-id propagation rules, the per-request log shape, the
startup banner, and the graceful-shutdown / panic-hook contract.

Updates the Environment variables table with LOG_FORMAT and
HEALTH_MAX_SATURATED_MS, the JSON config table with
health_max_saturated_ms, and the Logging subsection with the JSON
format option and URL redaction note.

Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com

@cursor

cursor Bot commented May 26, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only README changes with no runtime or configuration behavior changes in this diff.

Overview
README-only updates for starknet_transaction_prover: operators get clearer docs for how the service behaves under load and what shows up in logs.

The configuration tables now describe a FIFO queue beyond worker slots: MAX_CONCURRENT_REQUESTS is framed as parallel proving workers, with new MAX_QUEUED_REQUESTS and QUEUE_WAIT_TIMEOUT_MILLIS (and matching JSON config fields) explaining when clients see -32005 vs waiting.

Logging documents LOG_FORMAT (text vs json), JSON log shape, and URL redaction in startup/override messages so credentials in RPC URLs are not logged.

A new Observability section covers GET /health (unauthenticated, early in the router stack), x-request-id propagation and validation (including OHTTP outer vs inner ids), and the per-request event="http_request" structured log line (with probe and body-privacy notes). The API reference now points at /health alongside JSON-RPC.

Reviewed by Cursor Bugbot for commit 1b82441. Bugbot is set up for automated code reviews on this repo. Configure here.

@reviewable-StarkWare

Copy link
Copy Markdown

This change is Reviewable

@avi-starkware
avi-starkware force-pushed the avi/prover-v3/error-origin-logs branch 2 times, most recently from dd5534f to 8798823 Compare May 26, 2026 16:47
@avi-starkware
avi-starkware force-pushed the avi/prover-v3/docs branch 2 times, most recently from 197f826 to f6f9a32 Compare May 26, 2026 16:59
@avi-starkware
avi-starkware force-pushed the avi/prover-v3/error-origin-logs branch from 84a465f to e048443 Compare May 27, 2026 10:01
@avi-starkware
avi-starkware force-pushed the avi/prover-v3/error-origin-logs branch from e048443 to fa2eff6 Compare May 27, 2026 10:35
@avi-starkware
avi-starkware force-pushed the avi/prover-v3/docs branch 2 times, most recently from c097e37 to f3ee103 Compare May 27, 2026 12:55
@avi-starkware
avi-starkware force-pushed the avi/prover-v3/error-origin-logs branch 2 times, most recently from bc03f1e to f47a44b Compare May 27, 2026 13:11
@avi-starkware
avi-starkware force-pushed the avi/prover-v3/docs branch 2 times, most recently from 85c5cc9 to 31b5f68 Compare May 27, 2026 14:04
@avi-starkware
avi-starkware force-pushed the avi/prover-v3/error-origin-logs branch from f47a44b to 353e9ed Compare May 27, 2026 14:04
@avi-starkware
avi-starkware force-pushed the avi/prover-v3/docs branch 2 times, most recently from c1354ec to 60faf0c Compare July 12, 2026 12:39
@avi-starkware
avi-starkware force-pushed the avi/prover-v3/error-origin-logs branch 2 times, most recently from 486c09b to 553e864 Compare July 13, 2026 11:45
@avi-starkware
avi-starkware force-pushed the avi/prover-v3/docs branch 2 times, most recently from 4039e1e to f920731 Compare July 19, 2026 12:24
@avi-starkware
avi-starkware force-pushed the avi/prover-v3/error-origin-logs branch 2 times, most recently from 3deb8f7 to d817f3b Compare July 19, 2026 12:31
@avi-starkware
avi-starkware force-pushed the avi/prover-v3/docs branch 2 times, most recently from a142e5c to 8a451d7 Compare July 19, 2026 13:15
@avi-starkware
avi-starkware force-pushed the avi/prover-v3/error-origin-logs branch from d817f3b to 575006a Compare July 19, 2026 13:15
@avi-starkware
avi-starkware changed the base branch from avi/prover-v3/error-origin-logs to graphite-base/14203 August 25, 2026 08:22
@avi-starkware
avi-starkware changed the base branch from graphite-base/14203 to main August 25, 2026 08:23
@avi-starkware avi-starkware changed the title starknet_transaction_prover: document observability surface in README starknet_transaction_prover: document the existing observability surface in README Aug 25, 2026
@avi-starkware
avi-starkware changed the base branch from main to graphite-base/14203 August 25, 2026 10:14
@avi-starkware
avi-starkware changed the base branch from graphite-base/14203 to main-v0.14.4 August 25, 2026 10:14
@avi-starkware avi-starkware changed the title starknet_transaction_prover: document the existing observability surface in README starknet_transaction_prover: document existing logging, request ids and health probe in README Aug 25, 2026

@einat-starkware einat-starkware left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

@einat-starkware reviewed 1 file and all commit messages, and made 1 comment.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on Yoni-Starkware).

@avi-starkware
avi-starkware added this pull request to the merge queue Aug 25, 2026
Merged via the queue into main-v0.14.4 with commit 8017cc8 Aug 25, 2026
34 of 54 checks passed
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