IntenseFinance/nosqlbench
3
0
Fork 0
mirror of https://github.com/nosqlbench/nosqlbench.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs structure updates

Browse Source
This commit is contained in:
Jonathan Shook
2020-03-28 01:52:17 -05:00
parent 7a75408423
commit 0908f53494
29 changed files with 196 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
engine-docs/src/main/resources/docs-for-nb/getting_started/02_grafana_metrics.md → engine-docs/src/main/resources/docs-for-nb/basics/grafana_metrics.md
View File

7
engine-docs/src/main/resources/docs-for-nb/getting_started/01_example_commands.md
View File

@@ -89,9 +89,10 @@ Note the differences between this and the command that we used to generate the s
appropriately large number of cycles in actual testing to make your main test meaningful.
:::info
The cycles parameter is not just a quantity. It is a range of values. The `cycles=n` format is short for `cycles=0..n`,
which makes cycles a zero-based quantity by default. For example, cycles=5 means that the activity will use cycles
0,1,2,3,4, but not 5. The reason for this is explained in detail in the Activity Parameters section.
The cycles parameter is not just a quantity. It is a range of values. The `cycles=n` format is short for
`cycles=0..n`, which makes cycles a zero-based range. For example, cycles=5 means that the activity will use cycles
0,1,2,3,4, but
not 5. The reason for this is explained in detail in the Activity Parameters section.
:::
These parameters are explained in detail in the section on _Activity Parameters_.

0
engine-docs/src/main/resources/docs-for-nb/basics/parameter_types.md → engine-docs/src/main/resources/docs-for-nb/reference/parameter_types.md
View File

12
engine-docs/src/main/resources/docs-for-nb/showcase/portable_workloads.md
View File

@@ -31,12 +31,12 @@ parameter. This is a way of templating a workload and make it multi-purpose or a
## Experimentation Friendly
Because the workload YAML format is generic across activity types, it is possible to ask one acivity type to interpret
the statements that are meant for another. This isn't generally a good idea, but it becomes extremely handy when you
want to have a very high level activity type like `stdout` use a lower-level syntax like that of the `cql` activity
type. When you do this, the stdout activity type _plays_ the statements to your console as they would be executed in
CQL, data bindings and all.
Because the workload YAML format is generic across driver types, it is possible to ask one driver type to interpret the
statements that are meant for another. This isn't generally a good idea, but it becomes extremely handy when you want to
have a high level driver type like `stdout` interpret the syntax of another driver like `cql`. When you do this, the
stdout activity type _plays_ the statements to your console as they would be executed in CQL, data bindings and all.
This means you can empirically and substantively demonstrate and verify access patterns, data skew, and other dataset
details before you change back to cql mode and turn up the settings for a higher scale test.
details before you change back to cql mode and turn up the settings for a higher scale test. It takes away the guess
work about what your test is actually doing, and it works for all drivers.