v0.7.42 - Fix ephemeral event storage and document monitoring system

README.md

@@ -195,6 +195,9 @@ All commands are sent as NIP-44 encrypted JSON arrays in the event content. The
 - `pow_min_difficulty`: Minimum proof-of-work difficulty
 - `nip40_expiration_enabled`: Enable event expiration (`true`/`false`)
 
+**Monitoring Settings:**
+- `kind_24567_reporting_throttle_sec`: Minimum seconds between monitoring events (default: 5)
+
 ### Dynamic Configuration Updates
 
 C-Relay supports **dynamic configuration updates** without requiring a restart for most settings. Configuration parameters are categorized as either **dynamic** (can be updated immediately) or **restart-required** (require relay restart to take effect).
@@ -391,6 +394,68 @@ SELECT
 
 
 
+## Real-time Monitoring System
+
+C-Relay includes a subscription-based monitoring system that broadcasts real-time relay statistics using ephemeral events (kind 24567).
+
+### Activation
+
+The monitoring system activates automatically when clients subscribe to kind 24567 events:
+
+```json
+["REQ", "monitoring-sub", {"kinds": [24567]}]
+```
+
+For specific monitoring types, use d-tag filters:
+
+```json
+["REQ", "event-kinds-sub", {"kinds": [24567], "#d": ["event_kinds"]}]
+["REQ", "time-stats-sub", {"kinds": [24567], "#d": ["time_stats"]}]
+["REQ", "top-pubkeys-sub", {"kinds": [24567], "#d": ["top_pubkeys"]}]
+```
+
+When no subscriptions exist, monitoring is dormant to conserve resources.
+
+### Monitoring Event Types
+
+| Type | d Tag | Description |
+|------|-------|-------------|
+| Event Distribution | `event_kinds` | Event count by kind with percentages |
+| Time Statistics | `time_stats` | Events in last 24h, 7d, 30d |
+| Top Publishers | `top_pubkeys` | Top 10 pubkeys by event count |
+| Active Subscriptions | `active_subscriptions` | Current subscription details (admin only) |
+| Subscription Details | `subscription_details` | Detailed subscription info (admin only) |
+| CPU Metrics | `cpu_metrics` | Process CPU and memory usage |
+
+### Event Structure
+
+```json
+{
+  "kind": 24567,
+  "pubkey": "<relay_pubkey>",
+  "created_at": <timestamp>,
+  "content": "{\"data_type\":\"event_kinds\",\"timestamp\":1234567890,...}",
+  "tags": [
+    ["d", "event_kinds"]
+  ]
+}
+```
+
+### Configuration
+
+- `kind_24567_reporting_throttle_sec`: Minimum seconds between monitoring events (default: 5)
+
+### Web Dashboard Integration
+
+The built-in web dashboard (`/api/`) automatically subscribes to monitoring events and displays real-time statistics.
+
+### Performance Considerations
+
+- Monitoring events are ephemeral (not stored in database)
+- Throttling prevents excessive event generation
+- Automatic activation/deactivation based on subscriptions
+- Minimal overhead when no clients are monitoring
+
 ##  Direct Messaging Admin System
 
 In addition to the above admin API, c-relay allows the administrator to direct message the relay to get information or control some settings. As long as the administrator is signed in with any nostr client that allows sending nip-17 direct messages (DMs), they can control the relay.