Skip to content

Commit 772f17c

Browse files
committed
docs(metrics): add the two chain-tracker counter caveats
MAG-2930's acceptance list requires both caveats to travel with the new rpc_endpoint_tracker_requests_total row; the PR that added the row kept the tables brief and left them out. Without them a reader either misreads a fetch_latest_success rise after disabling fork detection as new load, or overcounts a metered node's real request volume by sum()ing across providers that share one URL.
1 parent 00a8476 commit 772f17c

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

‎docs/reference/metrics.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,19 @@ They split into **endpoint-scoped** (`rpc_endpoint_*`) and **router-scoped**
195195
| `rpc_endpoint_fetch_block_success` | Counter | `spec`, `apiInterface`, `endpoint_id` | Successful specific-block fetches. |
196196
| `rpc_endpoint_tracker_requests_total` | Counter | `spec`, `apiInterface`, `endpoint_id`, `kind` | Requests the chain tracker actually sent upstream, by `kind` — `latest_block`, or `block_hash` (zero unless [`--enable-fork-detection`](cli.md#polling-relief)). The only metric that measures tracker **request volume**. |
197197

198+
Two caveats when reading the chain-tracker counters:
199+
200+
- **`fetch_latest_success` can read *higher* with fork detection off.** With the
201+
flag on, a failed block-hash fetch aborts the poll cycle before the new-block
202+
callback fires, so endpoints with flaky hash fetches under-count detections;
203+
with it off, every detected block is recorded. A rise after disabling the flag
204+
is recovered counting, not extra load.
205+
- **`endpoint_id` holds a provider name, and several providers can share one
206+
physical URL.** The tracker polls per provider, so a bare `sum()` over
207+
`rpc_endpoint_tracker_requests_total` counts one physical request once per
208+
provider sharing that URL. When estimating the load on a metered node, keep
209+
the `endpoint_id` breakdown (or dedupe by URL) instead of summing blindly.
210+
198211
### Optimizer
199212

200213
| Metric | Type | Labels | Description |

0 commit comments

Comments
 (0)