diff --git a/README.md b/README.md index d14b96f..ad35d87 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ It supports authenticated publishing, subscribing, rate-limited usage tracking, - [x] Debug mode with detailed timing and proxy information - [x] Development mode with `--disable-auth` flag for testing - [x] Multiple output formats (table, JSON, YAML) for automation and scripting +- [x] Interactive tracer dashboard for real-time metrics visualization --- @@ -81,6 +82,9 @@ Download from [releases](https://github.com/getoptimum/mump2p-cli/releases/lates # Debug mode - detailed timing and proxy information ./mump2p --debug publish --topic=test-topic --message='Hello World' ./mump2p --debug subscribe --topic=test-topic + +# Tracer dashboard - real-time metrics visualization +./mump2p tracer dashboard ``` ### Transport Protocols diff --git a/docs/guide.md b/docs/guide.md index c9ac01f..861a6c6 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -468,6 +468,29 @@ This will display: - Time until usage counters reset - Timestamps of your last publish and subscribe operations +## Tracer Dashboard + +Interactive real-time dashboard showing network metrics, message statistics, and latency data. + +```sh +./mump2p tracer dashboard +``` + +**Options:** +- `--window`: Time window for metrics (default: `10s`) +- `--topic`: Topic for auto-publishing demo messages (default: `demo`) +- `--count`: Number of messages to auto-publish (default: `60`) +- `--interval-ms`: Interval between published messages in ms (default: `500`) + +**Example:** +```sh +./mump2p tracer dashboard --topic=metrics --count=100 --interval-ms=200 +``` + +Press `q` or `Ctrl+C` to exit. + +![Tracer Visualization](img/tracer.png) + ## Health Monitoring ### Check Proxy Server Health diff --git a/docs/img/tracer.png b/docs/img/tracer.png new file mode 100644 index 0000000..b8d9412 Binary files /dev/null and b/docs/img/tracer.png differ