You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: Add comprehensive IPC benchmark dashboard with enhanced UI and performance (#83)
- Implement modular dashboard architecture with interactive visualizations
- Add comprehensive data processing pipeline with caching and threading
- Create intuitive UI with Summary and Time Series analysis tabs
- Implement robust error handling and empty directory support
- Add detailed documentation and parameter guidance
- Enhance UI/UX with improved contrast, responsive design, and help system
- Fix all linting issues and improve code quality with flake8 compliance
- Add preset system for quick analysis configuration
- Implement settings preservation and cache management
- Support multiple IPC mechanisms: SharedMemory, UnixDomainSocket, PosixMessageQueue
Key Features:
- Interactive charts with Plotly integration
- Real-time data filtering and analysis
- Performance insights and statistical analysis
- Comprehensive error messages and data validation
- Professional dark theme with excellent accessibility
- Modular design for easy maintenance and extension
The Rusty-Comms Dashboard requires specific output formats and parameters to provide full functionality. Missing required outputs will result in limited dashboard features.
195
+
196
+
### Required Output Parameters
197
+
198
+
For full dashboard compatibility, you **must** use both output parameters:
Copy file name to clipboardExpand all lines: README.md
+132Lines changed: 132 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -415,6 +415,32 @@ Mechanism: SharedMemory
415
415
```
416
416
*Note: The `Final JSON Results` line will appear in the "Output Files Written" section if the `--output-file` flag was used.*
417
417
418
+
## Result Analysis
419
+
420
+
### Interactive Dashboard
421
+
422
+
For comprehensive analysis and visualization of benchmark results, use the included **Performance Dashboard** - a web application designed for IPC performance analysis:
-**Summary Analysis**: Performance overview cards, head-to-head comparisons, and statistical breakdowns
430
+
-**Time Series Analysis**: Temporal patterns, anomaly detection, and moving averages with 5 preset configurations
431
+
-**Interactive Exploration**: Filter by mechanism/message size, drill down into specific test runs
432
+
433
+
**Key Features:**
434
+
-**Advanced Visualizations**: Interactive time-series plots, statistical overlays, and comparative analysis
435
+
-**Intelligent Insights**: AI-powered performance recommendations and mechanism comparisons
436
+
-**Modern UI**: interface with preset configurations for different analysis scenarios
437
+
-**High Performance**: Handles millions of data points with threaded processing and smart caching
438
+
-**Export Capabilities**: Generate reports and capture insights for documentation
439
+
440
+
The dashboard automatically discovers all JSON and CSV output files in your results directory and provides powerful tools for understanding IPC performance characteristics across different scenarios.
441
+
442
+
For detailed dashboard documentation and setup instructions, see [`utils/dashboard/README.md`](utils/dashboard/README.md).
443
+
418
444
## Performance Considerations
419
445
420
446
### System Configuration
@@ -559,6 +585,112 @@ To help maintain branch quality and streamline development, the CI includes auto
559
585
560
586
-**Stale PR Notifier**: If a pull request becomes out-of-date with the `main` branch, a bot will post a comment to notify the author. The comment will include a list of recent commits to `main` to provide context.
561
587
588
+
## Dashboard Integration
589
+
590
+
The Rusty-Comms Dashboard provides powerful visualization and analysis capabilities for benchmark results. However, it requires specific output files to function properly.
591
+
592
+
### Prerequisites for Dashboard Usage
593
+
594
+
The dashboard requires **both** summary and streaming data files from ipc-benchmark:
595
+
596
+
-**Summary JSON**: Contains aggregated performance metrics and statistical analysis
597
+
-**Streaming JSON**: Contains individual message latency data for time series analysis
598
+
599
+
### Required ipc-benchmark Parameters
600
+
601
+
To generate dashboard-compatible output, you **must** include both output parameters:
0 commit comments