README
¶
SQLTraceBench
SQLTraceBench is a tool for benchmarking database performance using trace-based workload generation.
Features
- Trace-Driven: Generates workloads based on real SQL traces.
- Multi-Database Support: Architecture allows plugins for different databases (e.g., MySQL, ClickHouse, StarRocks).
- Statistical Modeling: Uses statistical models to synthesize realistic parameter values.
- Extensible: Easily add new database dialects and workload patterns.
- Visual Reports: Generates comprehensive HTML validation reports with interactive charts.
Getting Started
Check out our Quick Start Guide to get up and running in minutes!
It covers:
- Building the project
- Preparing data
- Running conversion, generation, and benchmarking commands
- Using the automated
examples/quickstart.shscript
Validation Reports
SQLTraceBench generates detailed validation reports to compare your benchmark results against a baseline.
Example of an HTML validation report showing QPS deviation and latency distribution.
See Report Interpretation Guide for details on how to read the reports.
Development
- Build:
make build - Test:
make test
Architecture
See docs/architecture/architecture.md for details on the system design.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
plugins/clickhouse
command
|
|
|
plugins/starrocks
command
|
|
|
server
command
|
|
|
sql_trace_bench
command
|
|
|
internal
|
|
|
domain/models
Package models contains the core domain models for the SQLTraceBench application.
|
Package models contains the core domain models for the SQLTraceBench application. |
|
domain/services
Package services contains the interfaces for the application's core services.
|
Package services contains the interfaces for the application's core services. |
|
infrastructure/parsers
Package parsers contains the concrete implementations of the Parser interface.
|
Package parsers contains the concrete implementations of the Parser interface. |
|
infrastructure/storage
Package storage provides in-memory storage implementations for the application's domain models.
|
Package storage provides in-memory storage implementations for the application's domain models. |
|
pkg
|
|
|
types
Package types contains shared data structures and constants used across the application.
|
Package types contains shared data structures and constants used across the application. |
|
starrocks/cmd
command
|
Click to show internal directories.
Click to hide internal directories.