initial readme

This commit is contained in:
Jonathan Shook 2020-02-20 15:37:24 -06:00
commit 0b733bfa1d
3 changed files with 71 additions and 0 deletions

14
.gitignore vendored Normal file
View File

@ -0,0 +1,14 @@
local/**
**/.idea
**/*.iml
**/target
**/.classpath
**/.project
**/.settings
**/*.log
**/logs
**/*.csv
**/*.*log
**/.DS_Store
metrics/**
bin/**

7
.travis.yml Normal file
View File

@ -0,0 +1,7 @@
language: java
jdk:
- openjdk12
cache:
directories:
- .autoconf
- $HOME/.m2

50
README.md Normal file
View File

@ -0,0 +1,50 @@
This project combines upstream projects of engineblock and virtualdataset into one main project. More details on release practices and contributor guidelines are on the way.
# Status
This is in active development. Collaborators are welcome. However, there is still work to be done to groom the slope for new users.
## nosqlbench
This project aims to provide a missing power tool in the test tooling arsenal.
The design goals:
1. Provide a useful and intuitive Reusable Machine Pattern for constructing and reasoning about concurrent performance tests. To encourage this, the runtime machinery is based on [simple and tangible core concepts](http://docs.nosqlbench.io/user-guide/concepts/).
2. Reduce testing time of complex scenarios with many variables. This is achieved by controlling tests from an [open javascript sandbox](http://docs.nosqlbench.io/user-guide/scripting/). This makes more sophisticated scenarios possible when needed.
3. Minimize the amount of effort required to get empirical results from a test cycle. For this, [metrics reporting](http://docs.nosqlbench.io/user-guide/metrics/) is baked in.
In short, Engine Block 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.
The most direct way to do this, if you are a tool developer, is to build your
own activity type drivers and embed EB as the core runtime. You can always
experiment with it and learn how it works by using the built-in diagnostic
drivers.
## History
The Engine Block project started as a branch of [test
client](http://github.com/jshook/testclient). It has since evolved to be more
generic.
## License
nosqlbench is licensed under the Apache Public License 2.0
## Thanks
[![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, 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 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>,
innovative and intelligent tools for profiling Java and .NET applications.