Merge pull request #54 from nosqlbench/more_sanitation

more sanitation

engine-docs/src/main/resources/docs-for-nb/01_dsbench/02_compatibility.md

@@ -13,7 +13,7 @@ DSBench runs on Linux as a binary distribution. Any modern Linux which can run A
 
 # Activity Types
 
-In dsbench terms, this means:
+In nosqlbench terms, this means:
 
 Activity types are how DSBench gets its support for different protocols or client drivers. The initial release of DSBench includes support for
 these activity types:

engine-docs/src/main/resources/docs-for-nb/01_dsbench/04_support_options.md

@@ -5,7 +5,7 @@ weight: 10
 
 # Support Options
 
-These guidelines are mirrored at the [Submitting Feedback](https://github.com/datastax/dsbench-labs/wiki/Submitting-Feedback) wiki page at the dsbench project site, which is also where the `[Submit Feedback]` link will take you.
+These guidelines are mirrored at the [Submitting Feedback](https://github.com/datastax/nosqlbench-labs/wiki/Submitting-Feedback) wiki page at the nosqlbench project site, which is also where the `[Submit Feedback]` link will take you.
 
 ## Community Support
 
@@ -13,14 +13,14 @@ It is supported by a community of active users at [DataStax DSBench Community](h
 
 ## Bug Fixes
 
-If you think you have found a bug, please [file a bug report](https://github.com/datastax/dsbench-labs/issues/new?labels=bug). DSBench is actively used within DataStax, and verified bugs will get attention as resources permit. Bugs reports which are more detailed, or bug reports which include steps to reproduce will get attention first.
+If you think you have found a bug, please [file a bug report](https://github.com/datastax/nosqlbench-labs/issues/new?labels=bug). DSBench is actively used within DataStax, and verified bugs will get attention as resources permit. Bugs reports which are more detailed, or bug reports which include steps to reproduce will get attention first.
 
 ## Feature Requests
 
 If you would like to see something in DSBench that is not there yet,
-please [submit a feature request](https://github.com/datastax/dsbench-labs/issues/new?labels=feature).
+please [submit a feature request](https://github.com/datastax/nosqlbench-labs/issues/new?labels=feature).
 
 ## Documentation Requests
 
-If you would like to see a specific dsbench or testing topic added to the guidebook, please [request docs content](https://github.com/datastax/dsbench-labs/issues/new?labels=docrequest).
+If you would like to see a specific nosqlbench or testing topic added to the guidebook, please [request docs content](https://github.com/datastax/nosqlbench-labs/issues/new?labels=docrequest).
 

engine-docs/src/main/resources/docs-for-nb/01_dsbench/05_troubleshooting.md

@@ -8,7 +8,7 @@ weight: 05
 This section will contain some troubleshooting guidance for
 common issue as we uncover them.
 
-## Errors while starting dsbench binary
+## Errors while starting nosqlbench binary
 
 If you get an error while trying to run the Linux DSBench binary, ensure that you have the system module installed for fuse. This module is used by the AppImage runtime that allows for a bundled binary.
 
@@ -20,5 +20,5 @@ You will need to make sure that the java binary is the correct one that is being
 
 ### Verify java version
 
-Each version of dsbench requires a particular major version of Java. For example, dsbench version 2.12.26 requires at least Java 12.
+Each version of nosqlbench requires a particular major version of Java. For example, nosqlbench version 2.12.26 requires at least Java 12.
 You can quickly check which version of java you have on your path with `java -version`

engine-docs/src/main/resources/docs-for-nb/01_dsbench/index.md

@@ -12,5 +12,5 @@ DSBench endeavors to be valuable to all users. We do this by making it easy for
 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 dsbench topics you'd like to
+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.

engine-docs/src/main/resources/docs-for-nb/02_getting_started/01_installing.md

@@ -9,21 +9,21 @@ If you are viewing this via the guidebook, you've already completed this step an
 
 If you are viewing this documentation as exported from the guidebook, then you need to get the binary or jar for your system.
 
-The binary is recommended, since it contains its own built-in JVM. If you are running Linux, get the dsbench binary for Linux.
+The binary is recommended, since it contains its own built-in JVM. If you are running Linux, get the nosqlbench binary for Linux.
 
 If you are running another system with a supported JVM, then you can do the following:
 
-1. Download dsbench.jar
+1. Download nosqlbench.jar
-2. Download and install the JVM corresponding to the dsbench version. (The second number of the dsbench version indicates the JVM version). For example, dsbench version 2.13.4 would require JVM 13.
+2. Download and install the JVM corresponding to the nosqlbench version. (The second number of the nosqlbench version indicates the JVM version). For example, nosqlbench version 2.13.4 would require JVM 13.
-3. Execute dsbench as `java -jar dsbench.jar ...`. You can replace the elipses `...` with any valid dsbench command line.
+3. Execute nosqlbench as `java -jar nosqlbench.jar ...`. You can replace the elipses `...` with any valid nosqlbench command line.
 
 If you have any trouble, check the troubleshooting section.
 
 
 ## Sanity Check
 
-To ensure that dsbench runs on your system, simply run it as
+To ensure that nosqlbench runs on your system, simply run it as
 
-    dsbench --version
+    nb --version
 
 

engine-docs/src/main/resources/docs-for-nb/02_getting_started/02_running.md

@@ -13,7 +13,7 @@ We will start by creating a simple schema in the database.
 From your command line, go ahead and execute the following command,
 replacing the `host=<dse-host-or-ip>` with that of one of your database nodes.
 
-    dsbench run type=cql yaml=baselines/cql-keyvalue tags=phase:schema host=<dse-host-or-ip>
+    ./nb run type=cql yaml=baselines/cql-keyvalue tags=phase:schema host=<dse-host-or-ip>
 
 This command is creating the following schema in your database:
 
@@ -53,7 +53,7 @@ Before sending our test writes to the database, we will use the `stdout` activit
 
 Go ahead and execute the following command:
 
-    ./dsbench start type=stdout yaml=baselines/cql-keyvalue tags=phase:rampup cycles=10
+    ./nb start type=stdout yaml=baselines/cql-keyvalue tags=phase:rampup cycles=10
 
 You should see 10 of the following statements in your console
 
@@ -74,7 +74,7 @@ One thing to know is that DSBench deterministically generates data, so the gener
 
 Now we are ready to write some data to our database. Go ahead and execute the following from your command line:
 
-    ./dsbench start type=cql yaml=baselines/cql-keyvalue tags=phase:rampup host=<dse-host-or-ip> cycles=100k --progress console:1s
+    ./nb start type=cql yaml=baselines/cql-keyvalue tags=phase:rampup host=<dse-host-or-ip> cycles=100k --progress console:1s
 
 Note the differences between this and the command that we used to generate the schema.
 
@@ -104,7 +104,7 @@ baselines/cql-keyvalue: 100.00%/Finished (details: min=0 cycle=100000 max=100000
 
 Now that we have a base dataset of 100k rows in the database, we will now run a mixed read / write workload, by default this runs a 50% read / 50% write workload.
 
-    ./dsbench start type=cql yaml=baselines/cql-keyvalue tags=phase:main host=<dse-host-or-ip> cycles=100k cyclerate=5000 threads=50 --progress console:1s
+    ./nb start type=cql yaml=baselines/cql-keyvalue tags=phase:main host=<dse-host-or-ip> cycles=100k cyclerate=5000 threads=50 --progress console:1s
 
 You should see output that looks like this:
 ```

engine-docs/src/main/resources/docs-for-nb/02_getting_started/04_reading_metrics.md

@@ -11,7 +11,7 @@ A set of core metrics are provided for every workload that runs with DSBench, re
 
 This is the primary metric that should be used to get a quick idea of the throughput and latency for a given run. It encapsulates the entire operation life cycle ( ie. bind, execute, get result back ).
 
-For this example we see that we averaged 3732 operations / second with 3.6ms 75th percentile latency and 23.9ms 99th percentile latency. Note the raw metrics are in microseconds. This duration_unit may change depending on how a user configures dsbench, so always double-check it.
+For this example we see that we averaged 3732 operations / second with 3.6ms 75th percentile latency and 23.9ms 99th percentile latency. Note the raw metrics are in microseconds. This duration_unit may change depending on how a user configures nosqlbench, so always double-check it.
 
 ```
 2019-08-12 15:46:01,310 INFO [main] i.e.c.ScenarioResult [Slf4jReporter.java:373] type=TIMER, name=baselines/cql-keyvalue.result, count=100000, min=233.48, max=358596.607, mean=3732.00338612, stddev=10254.850416061185, median=1874.815, p75=3648.767, p95=10115.071, p98=15855.615, p99=23916.543, p999=111292.415, mean_rate=4024.0234405430424, m1=3514.053841156124, m5=3307.431472596865, m15=3268.6786509004132, rate_unit=events/second, duration_unit=microseconds
@@ -55,7 +55,7 @@ DSBench extends many ways to report the metrics from a run, including:
 
 To get more information on these options, see the output of
 
-    dsbench --help
+    ./nb --help
 
 ### Congratulations
 

engine-docs/src/main/resources/docs-for-nb/02_getting_started/05_next_steps.md

@@ -5,15 +5,15 @@ weight: 5
 
 # 5. Next Steps
 
-Now that you've run dsbench for the first time and seen what it does, you can choose what level of customization you want for further testing.
+Now that you've run nosqlbench for the first time and seen what it does, you can choose what level of customization you want for further testing.
 
-The sections below describe key areas that users typically customize when working with dsbench.
+The sections below describe key areas that users typically customize when working with nosqlbench.
 
 Everyone who uses DSBench will want to get familiar with the basics section below. This is essential reading for new and experienced testers alike.
 
 ## High-Level Users
 
-Several canonical workloads are already baked-in to dsbench for immediate use. If you are simply wanting to drive workloads from dsbench without building a custom workload, then you'll want to learn about the available workloads and their options.
+Several canonical workloads are already baked-in to nosqlbench for immediate use. If you are simply wanting to drive workloads from nosqlbench without building a custom workload, then you'll want to learn about the available workloads and their options.
 
 Recommended reading for this is:
 1. 'Built-In Workloads'
@@ -21,7 +21,7 @@ Recommended reading for this is:
 
 ## Workload Builders
 
-If you want to use dsbench to build a tailored workload that closely emulates what a specific application would do, then you can build a YAML file that specifies all of the details of an iterative workload. You can specify the access patterns, data distributions, and more.
+If you want to use nosqlbench to build a tailored workload that closely emulates what a specific application would do, then you can build a YAML file that specifies all of the details of an iterative workload. You can specify the access patterns, data distributions, and more.
 
 The recommended reading for this is:
 
@@ -31,5 +31,5 @@ The recommended reading for this is:
 
 ## Scenario Developers
 
-The underlying runtime for a scenario in dsbench is based on EngineBlock,
+The underlying runtime for a scenario in nosqlbench is based on EngineBlock,
 which means it has all the scripting power that comes with that. For advanced scenario designs, iterative testing models, or analysis methods, you can use ECMAScript to control the scenario from start to finish. This is an advanced feature that is not recommended for first-time users. A guide for scenario developers will be released in increments.

engine-docs/src/main/resources/docs-for-nb/03_basics/01_command_line.md

@@ -6,7 +6,7 @@ weight: 01
 # DSBench CLI Options
 
 This is the same documentation you get in markdown format with the
-`dsbench --help` command.
+`nb --help` command.
 
 ---------------------------------------
 
@@ -20,7 +20,7 @@ Using multiples increases the level of the option, like '-vvv'.
 
 Long options, like '--help' are top-level options that may only be
 used once. These modify general behavior, or allow you to get more
-details on how to use dsbench.
+details on how to use nosqlbench.
 
 All other options are either commands, or named arguments to commands.
 Any single word without dashes is a command that will be converted
@@ -29,21 +29,21 @@ named argument to the previous command. The following example
 is a commandline with a command *start*, and two named arguments
 to that command.
 
-    dsbench start type=diag alias=example    
+    ./nb start type=diag alias=example    
 
 ### Discovery options ###
 
-These options help you learn more about running dsbench, and
+These options help you learn more about running nosqlbench, and
 about the plugins that are present in your particular version.
 
 Get a list of additional help topics that have more detailed
 documentation:
 
-    dsbench help topics
+    ./nb help topics
 
 Provide specific help for the named activity type:
 
-    dsbench help <activity type>
+    ./nb help <activity type>
 
 List the available activity types
 
@@ -55,7 +55,7 @@ Provide the metrics that are available for scripting
 
 ### Execution Options ###
 
-This is how you actually tell dsbench what scenario to run. Each of these
+This is how you actually tell nosqlbench what scenario to run. Each of these
 commands appends script logic to the scenario that will be executed.
 These are considered as commands, can occur in any order and quantity.
 The only rule is that arguments in the arg=value form will apply to

engine-docs/src/main/resources/docs-for-nb/03_basics/02_grafana_metrics.md

@@ -15,4 +15,4 @@ To ask DSBench to stand up your metrics infrastructure using a local docker runt
 
     --docker-metrics
 
-When this option is set, dsbench will start graphite, prometheus, and grafana automatically on your local docker, configure them to work together, and to send metrics the system automatically. It also imports a base dashboard for dsbench and configures grafana snapshot export to share with a central DataStax grafana instance (grafana can be found on localhost:3000 with the default credentials admin/admin).
+When this option is set, nosqlbench will start graphite, prometheus, and grafana automatically on your local docker, configure them to work together, and to send metrics the system automatically. It also imports a base dashboard for nosqlbench and configures grafana snapshot export to share with a central DataStax grafana instance (grafana can be found on localhost:3000 with the default credentials admin/admin).

engine-docs/src/main/resources/docs-for-nb/03_basics/03_parameter_types.md

@@ -21,7 +21,7 @@ They are part of the core API and used by every activity type. Core activity par
 These parameters are explained individually under the next section.
 
 *Custom* Activity Parameters are those provided by an activity type.
-These parameters are documented for each activity type. You can see them by running `dsbench help <activity type>`.
+These parameters are documented for each activity type. You can see them by running `nosqlbench help <activity type>`.
 
 Activity type parameters may be dynamic. *Dynamic* Activity Parameters are parameters which may be changed while an activity is running. This means that scenario scripting logic may change some variables while an activity is running, and that the runtime should dynamically adjust to match. Dynamic parameters are mainly used in more advanced scripting scenarios.
 

engine-docs/src/main/resources/docs-for-nb/03_basics/05_core_activity_params.md

@@ -13,7 +13,7 @@ either on the command line or via a scenario script. On the command line, these
 Some activity parameters are universal in that they can be used with any activity type. These parameters are recognized by DSBench whether or not they are recognized by a particular activity type implementation. These are called _core parameters_. Only core activity parameters are documented here.
 
 :::info
-To see what activity parameters are valid for a given activity type, see the documentation for that activity type with `dsbench help <activity type>`.
+To see what activity parameters are valid for a given activity type, see the documentation for that activity type with `nosqlbench help <activity type>`.
 :::
 
 ## type

engine-docs/src/main/resources/docs-for-nb/04_designing/02_data_bindings.md

@@ -30,7 +30,7 @@ The above bindings block is also a valid activity YAML, at least for the _stdout
      delta: WeightedStrings('one:1;six:6;three:3;')
 # EOF (control-D in your terminal)
 
-[test]$ dsbench run type=stdout yaml=stdout-test cycles=10
+[test]$ nosqlbench run type=stdout yaml=stdout-test cycles=10
 0,zero,00A_pro,six
 1,one,00B_pro,six
 2,two,00C_pro,three
@@ -66,7 +66,7 @@ bindings:
  delta: WeightedStrings('one:1;six:6;three:3;')
 # EOF (control-D in your terminal)
 
-[test]$ dsbench run type=stdout yaml=stdout-test cycles=10
+[test]$ nosqlbench run type=stdout yaml=stdout-test cycles=10
 This is a statement, and the file format doesn't
 know how statements will be used!
 submit job 1 on queue one with options 00B_pro;

engine-docs/src/main/resources/docs-for-nb/04_designing/04_stmt_tags.md

@@ -40,39 +40,39 @@ statements:
 # EOF (control-D in your terminal)
 
 # no tag filter matches any
-[test]$ dsbench run type=stdout yaml=stdout-test
+[test]$ nosqlbench run type=stdout yaml=stdout-test
 I'm alive!
 
 # tag name assertion matches
-[test]$ dsbench run type=stdout yaml=stdout-test tags=name
+[test]$ nosqlbench run type=stdout yaml=stdout-test tags=name
 I'm alive!
 
 # tag name assertion does not match
-[test]$ dsbench run type=stdout yaml=stdout-test tags=name2
+[test]$ nosqlbench run type=stdout yaml=stdout-test tags=name2
 02:25:28.158 [scenarios:001] ERROR i.e.activities.stdout.StdoutActivity - Unable to create a stdout statement if you have no active statements or bindings configured.
 
 # tag value assertion does not match
-[test]$ dsbench run type=stdout yaml=stdout-test tags=name:bravo
+[test]$ nosqlbench run type=stdout yaml=stdout-test tags=name:bravo
 02:25:42.584 [scenarios:001] ERROR i.e.activities.stdout.StdoutActivity - Unable to create a stdout statement if you have no active statements or bindings configured.
 
 # tag value assertion matches
-[test]$ dsbench run type=stdout yaml=stdout-test tags=name:foxtrot
+[test]$ nosqlbench run type=stdout yaml=stdout-test tags=name:foxtrot
 I'm alive!
 
 # tag pattern assertion matches
-[test]$ dsbench run type=stdout yaml=stdout-test tags=name:'fox.*'
+[test]$ nosqlbench run type=stdout yaml=stdout-test tags=name:'fox.*'
 I'm alive!
 
 # tag pattern assertion does not match
-[test]$ dsbench run type=stdout yaml=stdout-test tags=name:'tango.*'
+[test]$ nosqlbench run type=stdout yaml=stdout-test tags=name:'tango.*'
 02:26:05.149 [scenarios:001] ERROR i.e.activities.stdout.StdoutActivity - Unable to create a stdout statement if you have no active statements or bindings configured.
 
 # compound tag predicate matches every assertion
-[test]$ dsbench run type=stdout yaml=stdout-test tags='name=fox.*',unit=bravo
+[test]$ nosqlbench run type=stdout yaml=stdout-test tags='name=fox.*',unit=bravo
 I'm alive!
 
 # compound tag predicate does not fully match
-[test]$ dsbench run type=stdout yaml=stdout-test tags='name=fox.*',unit=delta
+[test]$ nosqlbench run type=stdout yaml=stdout-test tags='name=fox.*',unit=delta
 11:02:53.490 [scenarios:001] ERROR i.e.activities.stdout.StdoutActivity - Unable to create a stdout statement if you have no active statements or bindings configured.
 
 

engine-docs/src/main/resources/docs-for-nb/04_designing/05_stmt_blocks.md

@@ -25,7 +25,7 @@ blocks:
     beta: Combinations('b;l;o;c;k;2;-;COMBINATIONS;')
 # EOF (control-D in your terminal)
 
-[test]$ dsbench run type=stdout yaml=stdout-test cycles=10
+[test]$ nosqlbench run type=stdout yaml=stdout-test cycles=10
 0,block1-C
 1,block2-O
 2,block1-M

engine-docs/src/main/resources/docs-for-nb/04_designing/07_multi_docs.md

@@ -29,7 +29,7 @@ bindings:
 statements:
  - "doc2.number {numname}\n"
 # EOF (control-D in your terminal)
-[test]$ dsbench run type=stdout yaml=stdout-test cycles=10
+[test]$ nosqlbench run type=stdout yaml=stdout-test cycles=10
 doc1.form1 doc1.1
 doc1.form2 doc1.2
 doc2.number two

engine-docs/src/main/resources/docs-for-nb/04_designing/08_template_params.md

@@ -21,10 +21,10 @@ statements:
  - "<<linetoprint:MISSING>>\n"
 # EOF (control-D in your terminal)
 
-[test]$ dsbench run type=stdout yaml=stdout-test cycles=1
+[test]$ nosqlbench run type=stdout yaml=stdout-test cycles=1
 MISSING
 
-[test]$ dsbench run type=stdout yaml=stdout-test cycles=1 linetoprint="THIS IS IT"
+[test]$ nosqlbench run type=stdout yaml=stdout-test cycles=1 linetoprint="THIS IS IT"
 THIS IS IT
 ```
 

engine-docs/src/main/resources/docs-for-nb/04_designing/index.md

@@ -21,8 +21,8 @@ You will notice that this guide is not overly CQL-specific. That is because DSBe
 
 The built-in workloads that are include with DSBench are also shared on the github site where we manage the DSBench project:
 
-- [baselines](https://github.com/datastax/dsbench-labs/tree/master/sample-activities/baselines)
+- [baselines](https://github.com/datastax/nosqlbench-labs/tree/master/sample-activities/baselines)
-- [bindings](https://github.com/datastax/dsbench-labs/tree/master/sample-activities/bindings)
+- [bindings](https://github.com/datastax/nosqlbench-labs/tree/master/sample-activities/bindings)
 
 ### Follow the conventions
 

engine-docs/src/main/resources/docs-for-nb/05_activitytypes/06_cql_at.md

@@ -7,7 +7,7 @@ weight: 06
 
 This is the same documentation that you get when you run
 
-    dsbench help cql
+    ./nb help cql
 
 To select this activity type, pass `type=cql` to a run or start command.
 

engine-docs/src/main/resources/docs-for-nb/05_activitytypes/06_stdout_at.md

@@ -7,7 +7,7 @@ weight: 06
 
 This is the same documentation that you get when you run
 
-    dsbench help stdout
+    ./nb help stdout
 
 To select this activity type, pass `type=stdout` to a run or start command.
 

engine-docs/src/main/resources/docs-for-nb/05_activitytypes/index.md

@@ -7,4 +7,4 @@ Each DSBench scenario is comprised of one or more activities of a specific type.
 
 Additional activity types will be added in future releases. This section is a reference section that shows the help you would get with a command like:
 
-    dsbench help <activity type>
+    ./nb help <activity type>