The open source, pluggable, nosql benchmarking suite.
Go to file
2022-03-08 14:15:08 -06:00
.github remove CodeQL due to lack of J17 support 2022-03-07 17:06:06 -06:00
.nosqlbench backport github actions breaking change fix 2020-12-07 13:41:27 -06:00
.run chromedriver working, verbs alpha 2020-04-15 09:37:47 -05:00
adapter-cqld4 add aplv2 headers to adapter-cqld4 2022-03-08 14:06:09 -06:00
adapter-dynamodb add aplv2 headers to adapter-dynamodb 2022-03-08 14:08:16 -06:00
adapters-api add aplv2 headers to adapters-api 2022-03-08 14:08:48 -06:00
devdocs add LERP visualization 2021-11-18 16:48:39 -06:00
docsys add aplv2 headers to docsys 2022-03-08 14:09:10 -06:00
driver-cockroachdb add aplv2 headers to driver-cockroachdb 2022-03-08 14:10:49 -06:00
driver-diag add aplv2 headers to driver-diag 2022-03-08 14:11:49 -06:00
driver-http add aplv2 headers to driver-http 2022-03-08 14:12:07 -06:00
driver-jdbc add aplv2 headers to driver-jdbc 2022-03-08 14:12:21 -06:00
driver-jms add aplv2 headers to driver-jms 2022-03-08 14:12:30 -06:00
driver-jmx add aplv2 headers to driver-jmx 2022-03-08 14:12:37 -06:00
driver-kafka add aplv2 headers to driver-kafka 2022-03-08 14:12:46 -06:00
driver-mongodb add aplv2 headers to driver-mongodb 2022-03-08 14:12:56 -06:00
driver-pulsar add aplv2 headers to driver-pulsar 2022-03-08 14:13:05 -06:00
driver-stdout add aplv2 headers to driver-stdout 2022-03-08 14:13:15 -06:00
driver-tcp add aplv2 headers to driver-tcp 2022-03-08 14:13:23 -06:00
drivers-api add aplv2 headers to drivers-api 2022-03-08 14:13:34 -06:00
engine-api add aplv2 headers to engine-api 2022-03-08 14:14:08 -06:00
engine-cli add aplv2 headers to engine-cli 2022-03-08 14:14:19 -06:00
engine-clients add aplv2 headers to engine-client 2022-03-08 14:14:33 -06:00
engine-core add aplv2 headers to engine-core 2022-03-08 14:14:43 -06:00
engine-docker add aplv2 headers to engine-docker 2022-03-08 14:14:52 -06:00
engine-docs add aplv2 headers to engine-docs 2022-03-08 14:15:00 -06:00
engine-extensions add aplv2 headers to engine-extensions 2022-03-08 14:15:08 -06:00
engine-rest [maven-release-plugin] prepare for next development iteration 2022-02-24 21:10:36 +00:00
mvn-defaults add rat plugin to mvn-defaults module 2022-03-08 13:44:16 -06:00
nb [maven-release-plugin] prepare for next development iteration 2022-02-24 21:10:36 +00:00
nb-annotations [maven-release-plugin] prepare for next development iteration 2022-02-24 21:10:36 +00:00
nb-api fix missing NBConfiguration param name 2022-03-07 16:23:38 -06:00
nbr [maven-release-plugin] prepare for next development iteration 2022-02-24 21:10:36 +00:00
scripts docker fix for source image 2021-12-22 22:15:23 -06:00
sort_docs doc: old docs to be sorted 2021-09-13 09:56:47 -05:00
virtdata-api cherry-pick transient fields for Gson compat with newer JLS 2022-03-03 15:30:10 -06:00
virtdata-lang [maven-release-plugin] prepare for next development iteration 2022-02-24 21:10:36 +00:00
virtdata-lib-basics cherry-pick transient fields for Gson compat with newer JLS 2022-03-03 15:30:10 -06:00
virtdata-lib-curves4 cherry-pick transient fields for Gson compat with newer JLS 2022-03-03 15:30:10 -06:00
virtdata-lib-random [maven-release-plugin] prepare for next development iteration 2022-02-24 21:10:36 +00:00
virtdata-lib-realer [maven-release-plugin] prepare for next development iteration 2022-02-24 21:10:36 +00:00
virtdata-realdata [maven-release-plugin] prepare for next development iteration 2022-02-24 21:10:36 +00:00
virtdata-userlibs [maven-release-plugin] prepare for next development iteration 2022-02-24 21:10:36 +00:00
.editorconfig [issue-65] add EditorConfig configuration file 2020-03-16 13:51:41 +01:00
.gitignore cleanups 2021-11-10 15:41:21 -06:00
BUILDING.md Fix Java version in BUILDING.md 2020-04-14 10:28:24 +01:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2020-03-16 15:34:50 +00:00
CONTRIBUTING.md fix broken discord links 2021-03-15 10:21:23 -05:00
deploy.xml added deploy.xml 2020-03-10 02:56:24 -05:00
Dockerfile docker fix for source image 2021-12-22 22:15:23 -06:00
DOWNLOADS.md Fix markdown typos introduced by auto formatting 2021-09-17 13:12:56 -05:00
LICENSE.txt core project files 2020-03-16 08:41:22 -05:00
MODULES.md rename activitytype modules to driver modules 2020-05-05 11:29:30 -05:00
pom.xml remove rat plugin from root module 2022-03-08 13:43:58 -06:00
README.md Update README.md 2021-07-26 11:36:52 -05:00
release.xml fix missing release file 2020-06-17 17:48:09 -05:00
RELEASENOTES.md fix release 2022-02-24 14:56:43 -06:00

build

NoSQLBench

The Open Source, Pluggable, NoSQL Benchmarking Suite

Get it Here

Contribute to NoSQLBench

Read the Docs

What is NoSQLBench?

NoSQLBench is a serious performance testing tool for the NoSQL ecosystem. It brings together features and capabilities that are not found in any other tool.

  • You can run common testing workloads directly from the command line. You can start doing this within 5 minutes of reading this.
  • You can generate virtual data sets of arbitrary size, with deterministic data and statistically shaped values.
  • You can design custom workloads that emulate your application, contained in a single file, based on statement templates - no IDE or coding required.
  • You can immediately plot your results in a docker and grafana stack on Linux with a single command line option.
  • When needed, you can open the access panels and rewire the runtime behavior of NoSQLBench to do advanced testing, including a full scripting environment with Javascript.

The core machinery of NoSQLBench has been built with attention to detail. It has been battle tested within DataStax as a way to help users validate their data models, baseline system performance, and qualify system designs for scale.

In short, NoSQLBench wishes to be a programmable power tool for performance testing. However, it is somewhat generic. It doesn't know directly about a particular type of system, or protocol. It simply provides a suitable machine harness in which to put your drivers and testing logic. If you know how to build a client for a particular kind of system, it will let you load it like a plugin and control it dynamically.

Initially, NoSQLBench comes with support for CQL, but we would like to see this expanded with contributions from others.

Origins

The code in this project comes from multiple sources. The procedural data generation capability was known before as 'Virtual Data Set'. The core runtime and scripting harness was from the 'EngineBlock' project. The CQL support was previously used within DataStax. In March of 2020, DataStax and the project maintainers for these projects decided to put everything into one OSS project in order to make contributions and sharing easier for everyone. Thus, the new project name and structure was launched as nosqlbench.io. NoSQLBench is an independent project that is sponsored by DataStax.

We offer NoSQLBench as a new way of thinking about testing systems. It is not limited to testing only one type of system. It is our wish to build a community of users and practice around this project so that everyone in the NoSQL ecosystem can benefit from common concepts and understanding and reliable patterns of use.

Getting Support

In general, our goals with NoSQLBench are to make the help systems and examples wrap around the users like a suit of armor, so that they feel capable of doing most things autonomously. Please keep this in mind when looking for personal support form our community, and help us find those places where the docs are lacking. Maybe you can help us by adding some missing docs!

NoSQLBench Discord Server

We have a discord server. This is where users and developers can discuss anything about NoSQLBench and support each other. Please join us there if you are a new user of NoSQLBench!

Contributing

We are actively looking for contributors to help make NoSQLBench better. This is an ambitious project that is just finding its stride. If you want to be part of the next chapter in NoSQLBench development please look at CONTRIBUTING for ideas, and jump in where you feel comfortable.

All contributors are expected to abide by the CODE_OF_CONDUCT.

License

All of the code in this repository is licensed under the APL version 2. If you contribute to this project, then you must agree to license all of your constributions under this license.

System Compatibility

This is a Linux targeted tool, as most cloud/nosql testing is done on Linux instances. Some support for other systems is available, but more work is needed to support them fully. Here is what is supported for each:

  1. on Linux, all features are supported, for both nb.jar as well as the appimage binary nb
  2. on Mac, all features are supported, with nb.jar.
  3. On Windows, with nb.jar all features are supported, except --docker-metrics.

Thanks

DataStax This project is sponsored by DataStax -- The Open, Multi-Cloud Stack for Modern Data Apps built on Apache Cassandra™, Kubernetes *Based*, Developer *Ready* & Cloud *Delivered* and designed from the ground up to run anywhere, on any cloud, in any datacenter, and in every possible combination. DataStax delivers the ultimate hybrid and multi-cloud database.
YourKit Logo This project uses tools provided by YourKit, LLC. YourKit supports open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of YourKit Java Profiler and YourKit .NET Profiler, innovative and intelligent tools for profiling Java and .NET applications.
Deploys by Netlify This site (soon to be) deployed by Netlify!