Home - nosqlbench/nosqlbench GitHub Wiki

NoSqlBench allows you to run realistic workloads against your CQL systems without having to build your own testing harness. It builds on a set of core testing concepts and machinery to give you a performance testing power suit. Specifically, it allows you to control and customize your client operations so that they are representative of a real workload that you would run with your application. NoSQLBench acts like a Virtual Application.

If you don't want to manage this level of detail, you can use one of the built-in workloads with a single command.

This repository is where we manage issues, feature requests, and releases for NoSQLBench.

Supported Systems

NoSQLBench is released as a Linux compatible binary called nb. Future releases may include support for Mac or Windows.

NoSQLBench supports a variety of protocols. This means that a few activity types are bundled with the core nb binary. Activity types are how DSBench gets its support for different protocols or client drivers. You can see them as modules under the activitytype-* naming pattern in project root.

In binary form, NoSQLBench requires a Linux system to run, with FUSE installed. Most Linux systems already have this.

All user-facing functionality is provided via the command line, with plans to support more advanced usage via a custom UI.

A Preview

Basic Examples give a preview of some of the things you can do with NoSQLBench and how it works. The real docs are included in the tool itself.

Getting Started

The Online NoSQLBench Docs have everything you need to get started using NoSQLBench in 5 minutes or less.

Release Plans are how we plan to prioritize and scope releases going forward.

Support

Community Support

Bug Fixes

If you think you have found a bug, you may file a bug report. NoSQLBench is actively used within DataStax, and verified bugs will get attention as resources permit.

Thank You DataStax!

NoSQLBench development is supported by and used by DataStax as a core tool, for performance engineering as well as with users and customers for advanced workload characterization. In 2020, DataStax decided that it was time to share this tool more broadly so that we could work more closely with the NoSQL and Apache Cassandra community to build a shared toolkit that everyone can use.

Feature Requests

If you would like to see something in NoSQLBench that is not there yet, please submit a feature request.

Contributors

If you are a toolmaker or performance testing enthusiast, or a passing user who wants to help out, we encourage you to join us in making NoSQLBench better. It is our sincere wish that the effective ownership of this toolkit widens as more contributors work their way into trusted maintainer and contributor roles. We'll be looking for ways to make a wider ownership of NoSQLBench an inviting, satisfying and worthy endeavor for every contributor.