misc: add readme and license; change proj name

Author: pavdmyt

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Pavlo Dmytrenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,50 @@
+# ClickHouse Benchmark Comparison Tool
+
+## Description
+
+This is a web-based tool for comparing ClickHouse query benchmark results. It allows you to input and visualize performance metrics for two different ClickHouse queries, providing insights into their relative efficiency and performance characteristics.
+
+Key features:
+- Input areas for two SQL queries and their respective benchmark results
+- Parsing and visualization of benchmark data
+- Performance metrics comparison charts (QPS, RPS, MiB/s, etc.)
+- Query latency distribution chart
+- Key percentile latencies comparison
+- Raw data display
+
+## Installation
+
+To set up the project, follow these steps:
+
+1. Clone the repository
+2. Ensure you have Python 3.12+ installed.
+3. Install the required dependencies:
+
+   ```
+   pip install -r requirements.txt
+   ```
+
+## Usage
+
+To run the application:
+1. Navigate to the project directory in your terminal.
+2. Run the following command:
+
+   ```
+   streamlit run viz.py
+   ```
+
+3. The application will start, and you should see output similar to:
+
+   ```
+   You can now view your Streamlit app in your browser.
+   Local URL: http://localhost:8501
+   Network URL: http://192.168.1.5:8501
+   ```
+
+4. Open the provided URL in your web browser to access the tool.
+
+5. In the web interface:
+   - Enter your ClickHouse SQL queries in the "Query 1" and "Query 2" text areas.
+   - Paste the corresponding benchmark results in the "Benchmark results" text areas.
+   - The tool will automatically parse the input and generate visualizations and comparisons.

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
-name = "ch-bench"
+name = "ch_benchviz"
 version = "0.1.0"
-description = "Add your description here"
+description = "A Streamlit-based tool for visualizing and comparing ClickHouse query benchmark results"
 readme = "README.md"
 requires-python = ">=3.12"
 dependencies = [

uv.lock

@@ -5,7 +5,7 @@
 import re
 import sqlparse
 
-DEFAULT_DATA = """clickhouse-systemlogs-eu-aiven-management-pavdmyt-test.avns.net:20001, queries: 30, QPS: 28.404, RPS: 17619645.884, MiB/s: 566.200, result RPS: 59733.005, result MiB/s: 14.272.
+DEFAULT_DATA = """localhost:9000, queries: 30, QPS: 28.404, RPS: 17619645.884, MiB/s: 566.200, result RPS: 59733.005, result MiB/s: 14.272.
 
 0.000%          0.013 sec.
 10.000%         0.013 sec.
@@ -27,7 +27,7 @@
 STATUS_REGEX = re.compile(
     r"([\w.-]+:\d+),\s*queries:\s*(\d+),\s*QPS:\s*([\d.]+),\s*RPS:\s*([\d.]+),\s*MiB/s:\s*([\d.]+),\s*result RPS:\s*([\d.]+),\s*result MiB/s:\s*([\d.]+)"
 )
-DEFAULT_QUERY = """SELECT * FROM messages WHERE service_id = 40 LIMIT 50;"""
+DEFAULT_QUERY = """SELECT * FROM messages LIMIT 50;"""
 PERCENTILE_REGEX = re.compile(r"(\d+\.?\d*)%\s+(\d+\.\d+)\s+sec")
 KEY_PERCENTILES = [50.0, 95.0, 99.0]
 COLORSCHEME = px.colors.qualitative.D3