Skip to content

aerospike-community/tinkerbench

Repository files navigation

Tinkerbench

Tinkerbench is a benchmark harness tool designed for Apache TinkerPop based graph databases. It provides an efficient way to build, run, and analyze benchmarks, making it easy for developers to evaluate and optimize the performance of their gremlin queries.

It is a framework to help you:

  • Construct your own Benchmarks: Create benchmarks to mimic your application workload and test the performance of your graph database.

  • Execute your Benchmarks: Configure and run your benchmarks to mimic your application workloads. Analyze performance data and optimize your queries and configurations.

Although Tinkerbench is designed to be flexible and extensible, it is currently tested only with Aerospike Graph as the graph database. As such, the instructions and examples are specific to Aerospike Graph.

Getting Started

Prerequisites

  • A TinkerPop based graph database for the benchmark to connect to. To use Tinkerpop with Aerospike Graph, you need to have Aerospike Graph Service (AGS) setup and running. If you already have AGS setup and connected to Aerospike database proceed with the steps below. If not, you can use Aerolab to quickly setup Aerospike Graph.
  • Java 17
  • Maven

Installation

  1. Clone the repository
     git clone https://github.com/your-org/tinkerbench.git
     cd tinkerbench
    

Running Benchmarks

There are two benchmarks available in Tinkerbench out of the box.

Contributing

Contributions are welcome and encouraged! If you'd like to contribute to Tinkerbench, please submit a pull request or file an issue on the repository. Please ensure that no proprietary information is included in your contributions.

License

Tinkerbench is released under the MIT license. See LICENSE for more information.