From 4aef5f26b52b6e674ffac2cc3f254f3995b9ae03 Mon Sep 17 00:00:00 2001 From: Wesley Shillingford Date: Wed, 22 Apr 2020 17:58:04 +0100 Subject: [PATCH] Add Zach's table (thanks) --- docs/commands/rpc-protocol.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/commands/rpc-protocol.md b/docs/commands/rpc-protocol.md index 18fb73fce..595e81ebe 100644 --- a/docs/commands/rpc-protocol.md +++ b/docs/commands/rpc-protocol.md @@ -1731,7 +1731,22 @@ Return metrics from nodes. See [networking node telemetry](/protocol-design/netw } ``` -This contains a summarized view of the network, 10% of lower/upper bound results are removed to reduce the effect of outliers. Most values returned are averages, in some cases the mode (most common) is returned such as the **genesis_block** & **\*_version/maker** fields. **bandwidth_cap** can return either, 0 has a special meaning of unlimited, so the mode is chosen if there is more than 1 common result otherwise the results are averaged (excluding 0). **maker** is meant for third party node software so that it can be distinguished, **0** represents the Nano Foundation. **uptime** is measure in seconds and **timestamp** is the number of milliseconds since the UTC epoch at the point where the response is sent from the peer. **active_difficulty** is the current network difficulty, see [active_difficulty](/commands/rpc-protocol/#active_difficulty) "network_current". +This contains a summarized view of the network with 10% of lower/upper bound results removed to reduce the effect of outliers. Returned values are calculated as follows: + +| Field Name | Response details | +|------------|------------------------------------| +| **block_count** | average count of blocks in ledger (including unconfirmed) | +| **cemented_count** | average count of blocks cemented in ledger (only confirmed) | +| **unchecked_count** | average count of unchecked blocks | +| **account_count** | average count of accounts in ledger | +| **bandwidth_cap** | `0` = unlimited; the mode is chosen if there is more than 1 common result otherwise the results are averaged (excluding `0`) | +| **peer_count** | average count of peers nodes are connected to | +| **\*_version** | mode (most common) of (protocol, major, minor, patch, pre_release) versions | +| **uptime** | number of seconds since the UTC epoch at the point where the response is sent from the peer | +| **genesis_block** | mode (most common) of genesis block hashes | +| **maker** | meant for third party node software implementing the protocol so that it can be distinguished, `0` = Nano Foundation | +| **timestamp** | number of milliseconds since the UTC epoch at the point where the response is sent from the peer | +| **active_difficulty** | the current network difficulty, see [active_difficulty](/commands/rpc-protocol/#active_difficulty) "network_current" | This only returns values which have been cached by the ongoing polling of peer metric data. Each response is cached for 60 seconds on the main network and 15 seconds on beta; a few additional seconds are added on for response delays.