Skip to content

Latest commit

 

History

History
50 lines (42 loc) · 3.09 KB

README.md

File metadata and controls

50 lines (42 loc) · 3.09 KB
Raw

Rawhide Testing Framework

A Node.js powered database testing framework. It is slightly based on the YCSB benchmark and is highly extensible.

Requirements and Installation

  • Node.js 4.1 or higher

Rawhide is not yet published on npm but can be installed globally directly from the repository with: npm install -g git://github.com/JrSchild/rawhide.git. Run rawhide init project-name to bootstrap your testcase. Within this directory execute rawhide run to start your test.

Developing Rawhide

Right now the way to help developing the framework is to clone the project and cd into it. Create a symlink in the binary folder to this project: ln -s -f $(pwd)/bin/rawhide /usr/local/bin/rawhide. There is no need to create a test project to run it. From the project folder you can now do rawhide run to start it.

Classes

Spawner: Spawns workload threads and collects metrics.
Workload: Generates data and passes it to the model/adapter.
Model: Optionally transforms incoming data from the workload or database.
Adapter: Defines model-specific transactions to the database. Each model has an adapter for every kind of database.
Database: Database specific methods. These are automatically copied to the adapter.

Configuration

When throughtputMode set to true: rather than running with a fixed number of operations per second, it will try to execute as many operations per second as possible.

Metrics

Rawhide should retrieve the following metrics:

  • Max operations per second.
  • Latency for each transaction (read, write, etc...).
    • Both the database latency and model latency.
  • index memory
  • disk size

TODO

  • Emit executed operations per seconds from statistics.
  • Show queueCount and executed operations per seconds in the graph.
  • LimitCounter Unit Tests.
  • Design the model and adapter in such a way that the model can be omitted.
    • Connecting should go through the adapter rather than the model.
    • Adapter should be instantiated on Workload rather than on model.
  • Imporove error handling and graceful shutdown.
  • Create an awesome way of statistics collecting.
  • There seems to be a memory leak in the client child-processes.
  • Dockerize the databases and automate startup/shutdown/etc... through API.
  • Make using Docker optional
  • Improve error handling and graceful shutdown (http://stackoverflow.com/a/14032965)
  • Spawner.spawnThreads should return a promise of when the thread is connected.
  • Creating the table should be done at startup in Spawner, not at connection in four different threads.

Wishlist

  • rawhide add database will give you a set of questions to add a new database to your project. If the connector is not predefined it gives you the chance to do so. This will create the databases directory, update your configuration and package.json file.
  • ThroughputController independent of settings.
    • Implement PIDController for better algorithm to adjust operations per second.
  • The problem of ThroughputController is that it's response is too late. If the latency is five seconds, then the response of the PIDController will be five seconds behind as well.