aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/measurements.md1
-rw-r--r--docs/openapi.yaml7
2 files changed, 7 insertions, 1 deletions
diff --git a/docs/measurements.md b/docs/measurements.md
index 81ca0fc..cff7add 100644
--- a/docs/measurements.md
+++ b/docs/measurements.md
@@ -98,6 +98,7 @@ or caught up over many small messages.
| `topology.view.stable` | `stable_members` | Members whose registry entry says `stable`. |
| `topology.view.neighbours` | `neighbours` | Current neighbours: peers this node keeps alive and syncs with on its own. At least `k` (links chosen by either end count); well above `k` on a stable member that many others chose, bounded at about 8 × k. |
| `topology.view.stableNeighbours` | `stable_neighbours` | Of those, stable members. |
+| `topology.view.neighboursByTransport` | `neighbours_on{transport}` | Of those, by this node's transports (address schemes): the ones the member list gives an address on it. One on two transports counts on both; one it gives none for (not listed yet, or only connecting out), on none. About `k` on each ([`peers.md`](peers.md)); few on one means that transport reaches the swarm through few members. |
| `topology.view.ownTree.members` | `own_tree_members` | Other members in this node's own writer's tree: what its writes go along ([`peers.md`](peers.md)), as this node computes it (what members beyond its neighbours reach is taken from the member list's graph). |
| `topology.view.ownTree.depth`, `.meanDepth` | `own_tree_depth`, `own_tree_mean_depth` | The most hops along it from this node to one of them, and the mean. |
| `topology.view.ownTree.offTree` | `own_tree_off_members` | Members it doesn't reach: no member they reach comes before them, they are below one such, or the member list's graph doesn't connect them to this node. They get its writes by announcement. |
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index 3d74746..db73ede 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -2069,7 +2069,7 @@ components:
oneOf:
- type: 'null'
- type: object
- required: [members, reachable, stable, neighbours, stableNeighbours, ownTree]
+ required: [members, reachable, stable, neighbours, stableNeighbours, neighboursByTransport, ownTree]
properties:
members:
type: integer
@@ -2083,6 +2083,11 @@ components:
type: integer
stableNeighbours:
type: integer
+ neighboursByTransport:
+ type: object
+ additionalProperties:
+ type: integer
+ description: Neighbours the member list gives an address on each of this node's transports (address schemes); one on two counts on both.
ownTree:
description: This node's own writer's tree; null while it isn't in the member list's graph.
oneOf: