aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-07 22:35:09 +0100
committertv <tv@krebsco.de>2026-11-07 22:35:09 +0100
commit8391a6df59d566ffd7de01560c262d1afdd8d43d (patch)
tree982e5966ab3929ba4dab39d8e8e349c65ead1237 /docs
parent107e15335314f9ccdf57b297de45326f45571888 (diff)
dashboard: subscribed nodes' messages in the console
Each tick's messages of a subscribed node, listed in the console with this node's own, from its own stream. Auth plan M3 (live data from every reachable node).
Diffstat (limited to 'docs')
-rw-r--r--docs/access.md4
-rw-r--r--docs/dashboard.md14
-rw-r--r--docs/openapi.yaml12
3 files changed, 22 insertions, 8 deletions
diff --git a/docs/access.md b/docs/access.md
index e8f9893..961fc72 100644
--- a/docs/access.md
+++ b/docs/access.md
@@ -106,8 +106,8 @@ curl -H "Authorization: Bearer ct1.…" http://other-node:3000/store
`GET /auth/whoami` says who a request's user is, how it proved it, and what 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 traffic
-(`/admin/dashboard/traffic/own/events`), `/auth/refresh` and `/auth/whoami`, nothing
+its own links (`/admin/dashboard/links/own`, and its events) and messages
+(`/admin/dashboard/messages/own/events`), `/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 45a2248..c063c78 100644
--- a/docs/dashboard.md
+++ b/docs/dashboard.md
@@ -134,9 +134,10 @@ right after their legend makes all dots larger or smaller, and the `speed` slide
it makes them run faster or slower (0.1 to 0.9 map units per millisecond, 0.3 at
first: a link of 200 in about 0.7 s); both are kept in the browser. A picture
of the traffic, not a record of it. A subscribed node's messages with its peers run
-along its links too, from its own counts (read from it with the page's token, as its
-links are): those with this node are drawn from this node's counts, and between two
-subscribed nodes from what the sender sent. Links between other members show none.
+along its links too, from its messages of each 2 s (read from it with the page's token,
+as its links are): those with this node are drawn from this node's counts, and between
+two subscribed nodes from what the sender sent, so each message once. Links between
+other members show none.
`messages: on` after the sliders hides them (`messages: off` shows them again; the
legend and the sliders greyed meanwhile); the choice is kept in the browser.
@@ -322,6 +323,13 @@ PINGs with, are listed too: under the node at the address they went to, where it
known, else under the address. Not listed: WHO and ME, which stay in the layers
below the node (they are counted, [`measurements.md`](measurements.md), Traffic).
+A subscribed node's messages with its peers are listed too, as they come from it (every
+2 s): named by both ends, the receiver first (`b ← a`), each once, as on the map (those
+with this node only from this node, between two subscribed nodes from the sender); its
+tooltip names the node that logged it. Shown in the figures box, it says when, both
+ends, its type and size: the message itself is written out only on the node that
+logged it.
+
A click on a message shows it in the figures box: when, with whom, its type and size,
and the message written out (its bytes as sizes). A click on it again, or on anything on
the map or in the peers, goes back.
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index a5f7dcb..20cbf80 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -1050,11 +1050,17 @@ paths:
'401':
$ref: '#/components/responses/Unauthorized'
- /admin/dashboard/traffic/own/events:
+ /admin/dashboard/messages/own/events:
get:
tags: [Admin]
- summary: This node's traffic with each peer, every 2 s
- description: Server-sent events, `traffic` with what this node sent to and received from each peer by node ID, by kind (messages and bytes counted since it started, as `/peers` has them), every 2 s; `offline` when the node stops. For a page of another member's dashboard subscribed to this node, to draw its messages on the map (CORS, with a token).
+ summary: This node's messages, every 2 s
+ description: |
+ Server-sent events, `messages` with the messages this node sent and received in
+ the last 2 s (none too), each its number, time, way, peer, type, kind and size,
+ not written out; `offline` when the node stops. For a page of another member's
+ dashboard subscribed to this node: its console lists them, its map runs them
+ along this node's links (CORS, with a token). The node keeps its message log
+ while one is open.
responses:
'200':
description: The events.