Skip to content

docs: add tracer dashboard command documentation #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
swarna1101 merged 2 commits into from
Dec 18, 2025
Merged

docs: add tracer dashboard command documentation #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e601a0
docs: add tracer dashboard command documentation
swarna1101 Dec 17, 2025
ee30347
docs: clarify that --interval-ms is interval between published messages
swarna1101 Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

---

Expand Down Expand Up @@ -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
Expand Down
23 changes: 23 additions & 0 deletions docs/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Copy link

@coderabbitai coderabbitai bot Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick | 🔵 Trivial

Clarify --interval-ms description for consistency and explicitness.

The description "Interval between published messages in ms" is clear in context, but for full consistency with the preceding options (which explicitly mention "auto-publishing demo messages" and "auto-publish"), consider rephrasing to state "Interval between auto-published demo messages in ms". This matches the past reviewer's suggestion to be explicit about what messages are referenced. [Based on past review comment]

🔎 Apply this diff: 
- `--interval-ms`: Interval between published messages in ms (default: `500`)
+ `--interval-ms`: Interval between auto-published demo messages in ms (default: `500`)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- `--interval-ms`: Interval between published messages in ms (default: `500`)
- `--interval-ms`: Interval between auto-published demo messages in ms (default: `500`)
🤖 Prompt for AI Agents 
In docs/guide.md around line 483, the `--interval-ms` option text is ambiguous
compared to preceding options; update the description to explicitly read
"Interval between auto-published demo messages in ms (default: `500`)" so it
clearly matches the phrasing used for auto-publishing options and removes any
ambiguity about which messages are referenced.


**Example:**
```sh
Comment on lines +485 to +486
Copy link

@coderabbitai coderabbitai bot Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add blank line before code fence to comply with Markdown standards.

The fenced code block needs a blank line separating it from the preceding text per MD031.

🔎 Apply this diff: 
 **Example:**
+
 ```sh
 ./mump2p tracer dashboard --topic=metrics --count=100 --interval-ms=200

</details>

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 markdownlint-cli2 (0.18.1)</summary>

486-486: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

</details>

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

In docs/guide.md around lines 485-486, the fenced code block lacks a blank line
separating it from the preceding text which violates MD031; insert a single
blank line immediately before the triple-backtick opening fence so the paragraph
and the code fence are separated, then ensure the code fence contains the
intended shell block and closing backticks remain unchanged.


</details>

<!-- fingerprinting:phantom:triton:mongoose -->

<!-- This is an auto-generated comment by CodeRabbit -->

./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
Expand Down
Binary file added docs/img/tracer.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading