Skip to content

starknet_transaction_prover: document observability surface in README#14203

Open
avi-starkware wants to merge 1 commit into
avi/prover-v3/error-origin-logsfrom
avi/prover-v3/docs
Open

starknet_transaction_prover: document observability surface in README#14203
avi-starkware wants to merge 1 commit into
avi/prover-v3/error-origin-logsfrom
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
Copy link
Copy Markdown

cursor Bot commented May 26, 2026

PR Summary

Low Risk
README-only documentation; no service behavior or deployment logic changes.

Overview
Expands starknet_transaction_prover README so operators can run the service with clear observability expectations—no runtime code changes.

The API reference now calls out GET /health and GET /metrics beside the JSON-RPC spec. Configuration docs add LOG_FORMAT / --log-format, HEALTH_MAX_SATURATED_MS / --health-max-saturated-ms, and health_max_saturated_ms in the JSON config table. The Logging subsection covers JSON log shape and URL redaction for credentials in rpc_node_url and blocking_check_url.

A new Observability section documents health probe semantics (503 when saturated for the configured window, tied to -32005), the Prometheus metric names and bounded labels, x-request-id handling (including the deliberate two-id model for OHTTP), the http_request log line, startup banner fields, and graceful shutdown / panic-hook behavior.

Reviewed by Cursor Bugbot for commit 0563fbf. 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/error-origin-logs branch from 353e9ed to 894c08e Compare May 27, 2026 14:20
@avi-starkware avi-starkware force-pushed the avi/prover-v3/error-origin-logs branch from 894c08e to 086a69c Compare May 31, 2026 10:23
@avi-starkware avi-starkware force-pushed the avi/prover-v3/error-origin-logs branch from 086a69c to 1745223 Compare June 1, 2026 08:17
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>
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.

2 participants