IntenseFinance/nosqlbench
3
0
Fork 0
mirror of https://github.com/nosqlbench/nosqlbench.git synced 2025-01-28 16:34:31 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc updates

Browse Source
This commit is contained in:
Jonathan Shook 2020-03-17 06:09:37 -05:00
parent 79d51865fe
commit ca577558a3
3 changed files with 72 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -8,7 +8,7 @@
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.
other tool.
- You can run common testing workloads directly from the command line. You
can start doing this within 5 minutes of reading this.
@ -45,7 +45,7 @@ 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 primarily sponsored by DataStax.
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
@ -80,13 +80,13 @@ This is a Linux targeted tool, as most cloud/nosql testing is done on Linux inst
[![DataStax Logo](https://www.datastax.com/sites/default/files/content/graphics/logo/DS-logo-2019_1-25percent.png)](http://datastax.com/)
This project is sponsored by [DataStax](http://datstax.com/) -- The always-on,
active everywhere, distributed hybrid cloud database built on Apache Cassandra™,
and designed from the ground up to run anywhere, on any cloud, in any datacenter,
active everywhere, distributed hybrid cloud database built on Apache Cassandra™,
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](https://www.yourkit.com/images/yklogo.png)
This project uses tools provided by YourKit, LLC. YourKit supports open source projects
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
<a href="https://www.yourkit.com/java/profiler/">YourKit Java Profiler</a>
and <a href="https://www.yourkit.com/.net/profiler/">YourKit .NET Profiler</a>,

23
engine-docs/src/main/resources/docs-for-nb/01_nosqlbench/02_compatibility.md
View File

@ -1,25 +1,16 @@
---
title: Compatibility
title: Getting NoSQLBench
weight: 3
---
# Binary Format
nosqlbench is distributed primarily as a binary for Linux distributions. The nosqlbench binary includes its own OpenJDK runtime. It should work for most modern Linux distributions. The only requirement is that fuse be installed (it is usually already present) on the client system.
nosqlbench is distributed primarily as a binary for Linux distributions. This is the
easiest way to use. The nosqlbench binary includes its own OpenJDK runtime.
# Supported Systems
nosqlbench runs on Linux as a binary distribution. Any modern Linux which can run AppImage binaries should work.
# Activity Types
In nosqlbench terms, this means:
Activity types are how nosqlbench gets its support for different protocols or client drivers. The initial release of nosqlbench includes support for
these activity types:
- The CQL activity type
- The initial release of the CQL activity type uses the DataStax driver version 1.9.0
- The stdout activity type.
It should work for most modern Linux distributions. The only requirement is that fuse be
installed (it is usually already present) on the client system.
You can download the binary directly from the releases section of the nosqlbench
project site: [NoSQLBench Releases](https://github.com/nosqlbench/nosqlbench/releases)

67
engine-docs/src/main/resources/docs-for-nb/01_nosqlbench/index.md
View File

@ -3,14 +3,67 @@ title: Introducing nosqlbench
weight: 10
---
# nosqlbench docs
## Welcome to NoSQLBench
Welcome to the documentation for nosqlbench. nosqlbench is a power tool that emulates real application workloads. This means that you can fast-track performance, sizing and data model testing without writing your own testing harness.
Welcome to the documentation for NoSQLBench. This is a power tool that emulates real application workloads.
This means that you can fast-track performance, sizing and data model testing without writing your own testing harness.
nosqlbench endeavors to be valuable to all users. We do this by making it easy for you, our user, to do just what you need without worrying about the rest. If you need to do something simple, it should be simple to find the right settings and just do it. If you need something more sophisticated, then you should be able to find what you need with a reasonable amount of effort and no surprises.
NoSQLBench endeavors to be valuable to all users. We do this by making it easy for you, our user, to
do just what you need without worrying about the rest. If you need to do something simple, it should
be simple to find the right settings and just do it. If you need something more sophisticated, then you
should be able to find what you need with a reasonable amount of effort and no surprises.
Doing this well requires a coordinated effort in how the tools are documented and layered. We're just
getting started with the bundled docs that you are reading now. Look for new and expanded content in this
guidebook with each major release. We will be adding docs for more advanced users to unlock based on a how-to format.
## 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, EB 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 primarily 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.
Doing this well requires a coordinated effort in how the tools are documented and layered. We're just getting started with the bundled
docs that you are reading now. Look for new and expanded content in this guidebook with each release. We will be adding docs for more advanced users to unlock based on a how-to format.
We take requests! If you have specific nosqlbench topics you'd like to
have added to this guidebook, please make a request as described under the Support Options section.