Custom bench (#293)

Author: matthewmturner

.gitignore

@@ -98,3 +98,6 @@ benchmark_results/
 
 # For local query testing
 queries/**
+
+bench/url_files/*
+!bench/url_files/example_custom_bench.txt

bench/url_files/example_custom_bench.txt

@@ -0,0 +1,4 @@
+http://localhost:8080/catalog
+http://localhost:8080/table/datafusion/information_schema/tables
+http://localhost:8080/table/datafusion/information_schema/views
+http://localhost:8080/table/datafusion/information_schema/columns

docs/http_server.md

@@ -38,3 +38,34 @@ Prometheus metrics are automatically published.
 [flightsql_server]
 server_metrics_port = "0.0.0.0:9000"
 ```
+
+## Benchmarking
+
+Something useful that comes from having an HTTP server is that we can leverage an extensive ecosystem of the HTTP load generation tools to benchmark our performance.
+
+To get started with benchmarking you will first want to install the necessary tools.
+
+```sh
+# Installs `oha` which is a CLI for HTTP benchmarking
+just install-tools
+```
+
+Then you will want to start the `dft` HTTP server in one terminal window.
+
+```sh
+just serve-http
+```
+
+Finally, you can run a simple benchmark to make sure all the flows are working.
+
+```sh
+# Benchmarks running `SELECT 1`
+just bench-http-basic
+```
+
+You can add your own benchmark files in the `bench/url_files` directory to cater the benchmarks to your needs.  An example file is provided that you can use as reference.
+
+```sh
+just bench-http-custom example_custom_bench.txt
+```
+

justfile

@@ -2,10 +2,18 @@
 # We use shebang in places where multi line constructs are needed
 # Ref: https://github.com/casey/just?tab=readme-ov-file#if-statements
 
-# Assumes you already have `cargo` installed
-install-deps:
+# Installs `dft` dev tools. Assumes you already have `cargo` installed
+install-tools:
     cargo install oha
 
+# Starts a debug HTTP server
+serve-http:
+    RUST_LOG=info cargo r --features=http -- serve-http   
+
+# Starts a debug FlightSQL server
+serve-flight-sql:
+    RUST_LOG=info cargo r --features=flightsql -- serve-flight-sql
+
 # You should already have run `cargo r --features=http -- serve-http` in another shell
 bench-http-basic:
     #!/usr/bin/env sh
@@ -14,4 +22,17 @@ bench-http-basic:
       echo "HTTP server not running on http://localhost:8080"
       exit 1
     fi
-    oha "http://localhost:8080" -m POST -d '{"query": "SELECT 1"}'
+    oha "http://localhost:8080/sql" -m POST -d 'SELECT 1'
+
+# Run a custom benchmark script
+bench-http-custom file:
+    #!/usr/bin/env sh
+    http_code=$(curl "http://localhost:8080/health-check" --silent -o /dev/null -w "%{http_code}")
+    if [ "$http_code" -ne "200" ]; then
+      echo "HTTP server not running on http://localhost:8080"
+      exit 1
+    fi
+    custom_bench_path="bench/url_files/{{file}}"
+    echo "Running bench on $custom_bench_path"
+    echo ""
+    oha --urls-from-file "$custom_bench_path"