diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/access.md | 3 | ||||
| -rw-r--r-- | docs/dashboard.md | 17 |
2 files changed, 13 insertions, 7 deletions
diff --git a/docs/access.md b/docs/access.md index 38ae180..50c0265 100644 --- a/docs/access.md +++ b/docs/access.md @@ -173,7 +173,8 @@ it may do. Pages of other origins, the dashboards of other members, may call a node with a token: its own links (`/admin/dashboard/links/own`, and its events) and messages (`/admin/dashboard/messages/own/events`, and one written out, -`/admin/dashboard/messages/own/{seq}`), `/auth/refresh` and `/auth/whoami`, nothing +`/admin/dashboard/messages/own/{seq}`), its figures and peers (`/admin/stats`, +`/peers`), `/auth/refresh` and `/auth/whoami`, nothing else. A node allows the origins of the dashboards its member list names (`--dashboard-url`) and those of `--cors-origins`; without credentials (no cookie or password crosses origins: the page sends its token). diff --git a/docs/dashboard.md b/docs/dashboard.md index 590f72f..da69a16 100644 --- a/docs/dashboard.md +++ b/docs/dashboard.md @@ -287,14 +287,18 @@ What the Figures box shows is what is in focus: * **Nothing** (the default): this node's figures. * **A node** (click it on the map, or its row in Peers): this node's entry for that - peer (as `/peers` has it), and the links that member reports. Ringed on the map, + peer (as `/peers` has it), and the links that member reports. A node the page + subscribes to: its own figures first, as this node's are (its `/admin/stats`, read + from it every 2 s while in focus, with the page's token), then this node's entry for + it (`as this node sees it`) and its links, each a branch. Ringed on the map, highlighted in Peers. A second click on its row, a click beside the nodes or a click on this node goes back. * **A link** (click it): whether the member list intends it, each end's report of it (transport, relayed, round trip, dormant, its other transports, and how old the - report is), and, where this node is an end, the link as this node has it in `/peers`: - where messages go, its paths (each with its connection and round trip), and the - addresses known of the other end. Both ends are ringed. + report is), and, where this node or a node the page subscribes to is an end, the link + as that end has it in its `/peers` (a subscribed node's read from it, as its + figures): where messages go, its paths (each with its connection and round trip), + and the addresses known of the other end. Both ends are ringed. The focus is in the page's address (`#<node ID>`, or the two IDs of a link), so a reload keeps it and a link to the page can name it. @@ -321,8 +325,9 @@ The box is as tall as its rows, up to eight; then it scrolls. ## Figures The figures of what is in focus, as a tree, its keys at the top level and how many -beside the title: this node's `/admin/stats`, or a peer's `/peers` entry and, after it, -the links it reports (`links`), where the page has them. +beside the title: this node's `/admin/stats`; a subscribed node's own (`Node:`), with +this node's entry for it and its links after; or a peer's `/peers` entry and, after +it, the links it reports (`links`), where the page has them. Branches stay as opened across updates, and ages count on between them. What each figure means: [`measurements.md`](measurements.md). Some values get a reading after them, muted, in parentheses: a node ID its alias |