Updates

observability/hyper-p2p-metrics-aggregator/docs/api.md

@@ -1,23 +1,83 @@
-# hyper-p2p-metrics-aggregator API
+# API: hyper-p2p-metrics-aggregator
 
-**Status:** scaffold · **Protocol:** `metrics-aggregator/v1`
+**Protocol:** `metrics-aggregator/v1`
 
-## Class `HyperP2PMetricsAggregator`
+**Export:** `HyperP2PMetricsAggregator`
 
-Scaffold stub — methods throw `not implemented: scaffold` until promoted to production tier.
+## Overview
 
-### `constructor(opts?)`
+Production p2p module: Hyperswarm discovery + Protomux when `topic` is set.
 
-### `getStats()`
+## Constructor
 
-Returns `{ created, errors, protocol, tier: 'scaffold' }`.
+```js
+const mod = new HyperP2PMetricsAggregator(opts)
+```
 
-### `ready()`
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `topic` | varies | null | topic |
+| `keyPair` | KeyPair | random Ed25519 | keyPair |
 
-Resolves immediately (no-op).
+## Methods
 
-## Wire (planned)
+### `record(name, value, labels = {})`
 
-| Message | Direction | Notes |
-|---------|-----------|-------|
-| TBD | gossip | Defined in implementation pass |
+- **Returns:** `value`
+- **Throws:**
+  - `Error: metric name required`
+  - `Error: value must be a number`
+
+### `summarize(name, labels = {})`
+
+- **Returns:** `value`
+- **Throws:** — (none documented in method body)
+
+### `mergeRemote(name, value, labels = {})`
+
+- **Returns:** `value`
+- **Throws:** — (none documented in method body)
+
+### `exportAll(—)`
+
+- **Returns:** `value`
+- **Throws:** — (none documented in method body)
+
+### `getStats(—)`
+
+- **Returns:** `object`
+- **Throws:** — (none documented in method body)
+
+### `ready(—)`
+
+- **Returns:** `Promise`
+- **Throws:** — (none documented in method body)
+
+### `close(—)`
+
+- **Returns:** `Promise<void>`
+- **Throws:** — (none documented in method body)
+
+## Events
+
+| Event | Payload |
+|-------|---------|
+
+## getStats()
+
+Returns `{ ...this._stats }` — typically `ops`, `errors`, and module-specific counters (`created`, `relays`, `open`, `peers`, etc.).
+Library-only modules may include `mode: 'local'`.
+
+## Errors
+
+Stable message substrings: see [`../../_shared/ERROR_CODES.md`](../../_shared/ERROR_CODES.md).
+
+## P2P
+
+When `topic` is set, `ready()` joins Hyperswarm and opens Protomux `metrics-aggregator/v1`.
+
+## Testing
+
+```bash
+npm install && npm test
+```

observability/hyper-p2p-metrics-aggregator/docs/architecture.md

@@ -1,15 +1,43 @@
-# hyper-p2p-metrics-aggregator architecture
+# Architecture: hyper-p2p-metrics-aggregator
 
-**Tier:** scaffold · **Category:** `observability`
+**Category:** General
 
-## Role
+```mermaid
+flowchart LR
+  App[Application] --> Mod[HyperP2PMetricsAggregator]
+  Mod --> Mux[Protomux metrics-aggregator/v1]
+  Mux --> Swarm[Hyperswarm]
+```
 
-Metrics aggregation gossip.
+## Sequence (P2P)
+
+```mermaid
+sequenceDiagram
+  participant App
+  participant Mod as Module
+  participant SW as Hyperswarm
+  participant Peer
+  App->>Mod: ready(topic)
+  Mod->>SW: join(topic)
+  SW->>Peer: connection
+  Mod->>Peer: gossip / Protomux
+  Peer-->>Mod: onmessage
+  Mod-->>App: emit(event)
+```
+
+## Wire messages
+
+| type | fields | direction | behavior |
+|------|--------|-----------|----------|
+| `metric` | at, type | gossip | Handled in onmessage / gossipSend |
+
+## State model
+
+- In-memory `Map` / `Set` structures for hot path
+- Optional Hyperbee/Hypercore persistence when `storageDir` or `memoryOnly` is configured
+- `close()` tears down swarm, timers, and clears ephemeral state
 
 ## Composition
 
-Uses `../../_shared/p2p-bare.js` for Hyperswarm + Protomux when implemented. Does **not** duplicate Holepunch core storage/transport.
+Composes with: see MODULE_CATEGORIES.md.
 
-## Holepunch boundary
-
-Inspiration: n/a