Skip to content

Commit 996dd28

Browse files
committed
docs(gw-listener): update metrics docs for wall-clock timeouts, clarify Default is test-only
1 parent 5962e82 commit 996dd28

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

coprocessor/fhevm-engine/gw-listener/src/lib.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ pub fn chain_id_from_env() -> Option<ChainId> {
7878
}
7979
}
8080

81+
/// Default is used by unit tests only. Production defaults come from
82+
/// the CLI arg definitions in `bin/gw_listener.rs` (e.g. `--drift-no-consensus-timeout 5m`).
8183
impl Default for ConfigSettings {
8284
fn default() -> Self {
8385
Self {

docs/metrics/metrics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,11 @@ Note that recommendations assume a smoke test that runs transactions/requests at
137137

138138
#### Metric Name: `coprocessor_gw_listener_consensus_latency_blocks`
139139
- **Type**: Histogram
140-
- **Description**: Block distance between the first observed submission and the consensus event for a handle. Use this distribution to tune `--drift-no-consensus-timeout-blocks`: the timeout should sit above the normal tail so it alerts on truly stalled handles without retaining healthy ones for too long. Bucket boundaries: 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144.
140+
- **Description**: Block distance between the first observed submission and the consensus event for a handle. Diagnostic metric for understanding on-chain latency; timeouts are wall-clock based and configured via `--drift-no-consensus-timeout`. Bucket boundaries: 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144.
141141

142142
#### Metric Name: `coprocessor_gw_listener_post_consensus_completion_blocks`
143143
- **Type**: Histogram
144-
- **Description**: Block distance between the consensus event and seeing all expected submissions for a handle. Use this distribution to tune `--drift-post-consensus-grace-blocks`: the grace window should sit above the normal tail so lagging-but-healthy coprocessors do not alert, while truly missing submissions age out. Bucket boundaries: 0, 1, 2, 3, 5, 8, 13, 21, 34.
144+
- **Description**: Block distance between the consensus event and seeing all expected submissions for a handle. Diagnostic metric for understanding on-chain completion latency; the grace window is wall-clock based and configured via `--drift-post-consensus-grace`. Bucket boundaries: 0, 1, 2, 3, 5, 8, 13, 21, 34.
145145

146146
### zkproof-worker
147147

0 commit comments

Comments
 (0)