diff --git a/README.md b/README.md index 1bed8f52..992cb81c 100644 --- a/README.md +++ b/README.md @@ -137,35 +137,34 @@ Build the SBK: untar the SBK to local folder ``` -tar -xvf ./build/distributions/sbk.tar -C ./build/distributions/. +tar -xvf ./build/distributions/sbk-5.0.tar -C ./build/distributions/. ``` Running SBK locally: ``` -/./build/distributions/sbk/bin/sbk -help +/./build/distributions/sbk-5.0/bin/sbk -help ... -usage: sbk +usage: sbk -out SystemLogger Storage Benchmark Kit -class Storage Driver Class, Available Drivers [Activemq, Artemis, AsyncFile, - BookKeeper, Cassandra, CephS3, ConcurrentQ, CouchDB, - CSV, Db2, Derby, FdbRecord, File, FileStream, - FoundationDB, H2, HDFS, Hive, Jdbc, Kafka, LevelDB, - MariaDB, MinIO, MongoDB, MsSql, MySQL, Nats, - NatsStream, Nsq, Null, OpenIO, PostgreSQL, Pravega, - Pulsar, RabbitMQ, Redis, RedPanda, RocketMQ, RocksDB, - SeaweedS3, SQLite] - -context Prometheus Metric context; - 'no' disables this option; default: 9718/metrics - -csvfile CSV file to record results; - 'no' disables this option, default: no + BookKeeper, Cassandra, CephS3, Couchbase, CouchDB, + CSV, Db2, Derby, Dynamodb, Exasol, FdbRecord, File, + FileStream, FoundationDB, H2, HDFS, Hive, Jdbc, + Kafka, LevelDB, MariaDB, Memcached, MinIO, MongoDB, + MsSql, MySQL, Nats, NatsStream, Nsq, Null, OpenIO, + PostgreSQL, Pravega, Pulsar, RabbitMQ, Redis, + RedPanda, RocketMQ, RocksDB, SeaweedS3, SQLite] -help Help message -maxlatency Maximum latency; use '-time' for time unit; default:180000 ms -minlatency Minimum latency; use '-time' for time unit; default:0 ms + -out Logger Driver Class, + Available Drivers [CSVLogger, GrpcLogger, + PrometheusLogger, Sl4jLogger, SystemLogger] -readers Number of readers -records Number of records(events) if 'seconds' not specified; otherwise, Maximum records per second by writer(s); @@ -177,8 +176,6 @@ Storage Benchmark Kit -rq Benchmark Reade Requests; default: false -rsec Number of seconds/step for readers, default: 0 -rstep Number of readers/step, default: 1 - -sbm SBM host; 'no' disables this option, default: no - -sbmport SBM Port; default: 9717 -seconds Number of seconds to run if not specified, runs forever -size Size of each message (event or record) @@ -630,16 +627,16 @@ For eclipse, you can generate eclipse project files by running `./gradlew eclips untar the SBK to local folder ``` -tar -xvf ./build/distributions/sbk.tar -C ./build/distributions/. +tar -xvf ./build/distributions/sbk-5.0.tar -C ./build/distributions/. ``` 6. To invoke the benchmarking of the driver you have to issue the parameters "-class < your driver name>" Example: For pulsar driver ``` -./build/distributions/sbk/bin/sbk -class pulsar -help +./build/distributions/sbk-5.0/bin/sbk -class pulsar -help -usage: sbk -class Pulsar +usage: sbk -class pulsar -out SystemLogger Storage Benchmark Kit -ackQuorum AckQuorum default: 1 @@ -647,10 +644,6 @@ Storage Benchmark Kit topic, default: null -broker Broker URI, default: tcp://localhost:6650 -cluster Cluster name (optional parameter) - -context Prometheus Metric context; - 'no' disables this option; default: 9718/metrics - -csvfile CSV file to record results; - 'no' disables this option, default: no -deduplication Enable or Disable Deduplication; default: false -ensembleSize EnsembleSize default: 1 -help Help message @@ -671,8 +664,6 @@ Storage Benchmark Kit -rq Benchmark Reade Requests; default: false -rsec Number of seconds/step for readers, default: 0 -rstep Number of readers/step, default: 1 - -sbm SBM host; 'no' disables this option, default: no - -sbmport SBM Port; default: 9717 -seconds Number of seconds to run if not specified, runs forever -size Size of each message (event or record) @@ -695,6 +686,7 @@ Storage Benchmark Kit Please report issues at https://github.com/kmgowda/SBK + ``` ### Add your driver to SBK Manually