This is the benchmark suite for the PostgreSQL data connector.
Running run.sh with a benchmark name as an argument will:
- build the PostgreSQL data connector Docker image,
- start the database with Chinook data,
- start the agent using an associated NDC metadata file, and
- run a benchmark using k6.
Running without arguments will list available benchmarks.
Everything is run through Docker Compose.
The Docker image for the agent is built with Nix. If you haven't built with Nix before (or it's been a while), this may take some time at first.
- Nix, to build the Docker image
- Install Nix
- Configure Nix by adding the following line to
~/.config/nix/nix.conf:extra-experimental-features = flakes nix-command
- Docker and Docker Compose, to run the containers (see the root README)
When the benchmarks finish, the results will be printed.
There is a Grafana dashboard which can be viewed as follows:
- Open [http://localhost:64300][].
- Open the menu on the left and choose "Dashboards".
- Choose the "Test Result" dashboard.
You can add a benchmark by copying one of the files in the "benchmarks" subdirectory and altering it.
Please make sure that the name of the file corresponds to the testid.
For further information, consult the k6 documentation.