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 changes; no runtime, API, or security behavior is modified.

Overview
Documentation-only update to crates/starknet_transaction_prover/README.md so operators can run the prover with health checks, metrics, and structured logging without reading the code.

The API reference now points at GET /health and GET /metrics beside the JSON-RPC surface. Config tables add LOG_FORMAT, HEALTH_MAX_SATURATED_MS, and JSON health_max_saturated_ms. The Logging section covers JSON log output and URL credential redaction.

A new Observability section documents probe behavior (including saturation-driven 503 tied to -32005), Prometheus metric names and bounded labels, x-request-id handling, per-request log shape, startup banner redaction, and graceful shutdown / panic-hook behavior.

Reviewed by Cursor Bugbot for commit f6f9a32. 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
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