scriptoriumadmin/featurebase
1
0
Fork 0
mirror of https://github.com/featurebasedb/featurebase.git synced 2026-09-05 16:15:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

clean up benchmark docs a bit

Browse source
This commit is contained in:
jaffee 2016-12-06 11:00:59 -06:00
parent cc55d32059
commit bde927cdf1
1 changed files with 18 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -223,29 +223,24 @@ $ go install --ldflags="-X main.Version=1.0.0"
## Benchmarks
To run a preconfigured benchmark do:
The usual interface for running benchmarks is:
```
pilosactl bspawn benchmark-file.json
```
There are several example json config files in `cmd/pilosactl`
The `bspawn` command calls other `pilosactl` subcommands such as `create` and `bagent` to perform the benchmarks. These commands can also be used directly if one wishes e.g. to just create a cluster, or locally run a benchmarks against an existing cluster. Pass the `-help` flag to either to get more information about its usage.
### Configuration Format
bspawn uses a json config format that has 5 top level items - an annotated example is below.
bspawn uses a json config format that has 5 top level items - an example is below.
```json
{
// CreatorArgs specifies the pilosa cluster that should be created to run benchmarks against. For more information about the configuration for this option, see the `pilosactl create` documentation.
"CreatorArgs": ["-type", "local", "-serverN", "1", "-replicaN", "1"],
// If PilosaHosts is set, CreatorArgs will be ignored, and an existing pilosa cluster specified by the list of hosts will be used.
"PilosaHosts": ["localhost:19327"],
// Agents specifies the host(s) that the benchmark should be run from. Currently only running from localhost is supported.
"Agents": { "Type": "local" },
// If AgentHosts is specified, Agents is ignored, and the existing
// agents specified here are used. This is not yet implemented.
"AgentHosts": ["localhost"],
// Benchmarks is where the actual benchmarks to run are specified - each contains a `Num` which is the number of agents that should run that benchmark, and Args which specifies the benchmark. For more information about Args, see the `pilosactl bagent` documentation. The benchmarks in the `Benchmarks` list will be run concurrently.
"Benchmarks": [
{
"Num": 1,
@ -260,5 +255,19 @@ bspawn uses a json config format that has 5 top level items - an annotated examp
```
#### CreatorArgs
Specifies the pilosa cluster that should be created to run benchmarks against. For more information about the configuration for this option, see the `pilosactl create -help`
#### PilosaHosts
If PilosaHosts is set, CreatorArgs will be ignored, and an existing pilosa cluster specified by the list of hosts will be used.
#### Agents
Agents specifies the host(s) that the benchmark should be run from. Currently only running from localhost is supported.
#### AgentHosts
If AgentHosts is specified, Agents is ignored, and the existing agents specified here are used. This is not yet implemented.
#### Benchmarks
Benchmarks is where the actual benchmarks to run are specified - each contains a `Num` which is the number of agents that should run that benchmark, and Args which specifies the benchmark. The benchmarks in the `Benchmarks` list will be run concurrently. For more information about Args, see the `pilosactl bagent -help`.
For documentation on a specific `bagent` subcommand do `pilosactl bagent <subcommand> -help`