Bugfixes and readme updates.

Signed-off-by: Keshava Munegowda <[email protected]>
kmgowda · Aug 24, 2024 · de98c45 · de98c45
1 parent e331690
commit de98c45
Show file tree

Hide file tree

Showing 6 changed files with 363 additions and 283 deletions.
diff --git a/README.md b/README.md
@@ -148,50 +148,54 @@ Running SBK locally:
 usage: sbk -out SystemLogger
 Storage Benchmark Kit
 
- -class <arg>        Storage Driver Class,
-                     Available Drivers [Activemq, Artemis, AsyncFile,
-                     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 <arg>   Maximum latency;
-                     use '-time' for time unit; default:180000 ms
- -minlatency <arg>   Minimum latency;
-                     use '-time' for time unit; default:0 ms
- -out <arg>          Logger Driver Class,
-                     Available Drivers [CSVLogger, GrpcLogger,
-                     PrometheusLogger, Sl4jLogger, SystemLogger]
- -readers <arg>      Number of readers
- -records <arg>      Number of records(events) if 'seconds' not specified;
-                     otherwise, Maximum records per second by writer(s);
-                     and/or
-                     Number of records per second by reader(s)
- -ro <arg>           Readonly Benchmarking,
-                     Applicable only if both writers and readers are set;
-                     default: false
- -rq <arg>           Benchmark Reade Requests; default: false
- -rsec <arg>         Number of seconds/step for readers, default: 0
- -rstep <arg>        Number of readers/step, default: 1
- -seconds <arg>      Number of seconds to run
-                     if not specified, runs forever
- -size <arg>         Size of each message (event or record)
- -sync <arg>         Each Writer calls flush/sync after writing <arg>
-                     number of of events(records); and/or
-                     <arg> number of events(records) per Write or Read
-                     Transaction
- -throughput <arg>   If > 0, throughput in MB/s
-                     If 0, writes/reads 'records'
-                     If -1, get the maximum throughput (default: -1)
- -time <arg>         Latency Time Unit [ms:MILLISECONDS, mcs:MICROSECONDS,
-                     ns:NANOSECONDS]; default: ms
- -wq <arg>           Benchmark Write Requests; default: false
- -writers <arg>      Number of writers
- -wsec <arg>         Number of seconds/step for writers, default: 0
- -wstep <arg>        Number of writers/step, default: 1
+ -class <arg>           Storage Driver Class,
+                        Available Drivers [Activemq, Artemis, AsyncFile,
+                        Atomicq, BookKeeper, Cassandra, CephS3,
+                        ConcurrentQ, Conqueue, Couchbase, CouchDB, CSV,
+                        Db2, Derby, Dynamodb, Exasol, FdbRecord, File,
+                        FileStream, FoundationDB, H2, HDFS, Hive, Jdbc,
+                        Kafka, LevelDB, Linkedbq, MariaDB, Memcached,
+                        MinIO, MongoDB, MsSql, MySQL, Nats, NatsStream,
+                        Nsq, Null, OpenIO, PostgreSQL, Pravega, Pulsar,
+                        RabbitMQ, Redis, RedPanda, RocketMQ, RocksDB,
+                        SeaweedS3, SQLite, Syncq]
+ -help                  Help message
+ -maxlatency <arg>      Maximum latency;
+                        use '-time' for time unit; default:180000 ms
+ -millisecsleep <arg>   Idle sleep in milliseconds; default: 0 ms
+ -minlatency <arg>      Minimum latency;
+                        use '-time' for time unit; default:0 ms
+ -out <arg>             Logger Driver Class,
+                        Available Drivers [CSVLogger, GrpcLogger,
+                        PrometheusLogger, Sl4jLogger, SystemLogger]
+ -readers <arg>         Number of readers
+ -records <arg>         Number of records(events) if 'seconds' not
+                        specified;
+                        otherwise, Maximum records per second by
+                        writer(s); and/or
+                        Number of records per second by reader(s)
+ -ro <arg>              Readonly Benchmarking,
+                        Applicable only if both writers and readers are
+                        set; default: false
+ -rq <arg>              Benchmark Reade Requests; default: false
+ -rsec <arg>            Number of seconds/step for readers, default: 0
+ -rstep <arg>           Number of readers/step, default: 1
+ -seconds <arg>         Number of seconds to run
+                        if not specified, runs forever
+ -size <arg>            Size of each message (event or record)
+ -sync <arg>            Each Writer calls flush/sync after writing <arg>
+                        number of of events(records); and/or
+                        <arg> number of events(records) per Write or Read
+                        Transaction
+ -throughput <arg>      If > 0, throughput in MB/s
+                        If 0, writes/reads 'records'
+                        If -1, get the maximum throughput (default: -1)
+ -time <arg>            Latency Time Unit [ms:MILLISECONDS,
+                        mcs:MICROSECONDS, ns:NANOSECONDS]; default: ms
+ -wq <arg>              Benchmark Write Requests; default: false
+ -writers <arg>         Number of writers
+ -wsec <arg>            Number of seconds/step for writers, default: 0
+ -wstep <arg>           Number of writers/step, default: 1
 
 Please report issues at https://github.com/kmgowda/SBK
 
@@ -649,6 +653,7 @@ Storage Benchmark Kit
  -help                  Help message
  -maxlatency <arg>      Maximum latency;
                         use '-time' for time unit; default:180000 ms
+ -millisecsleep <arg>   Idle sleep in milliseconds; default: 0 ms
  -minlatency <arg>      Minimum latency;
                         use '-time' for time unit; default:0 ms
  -partitions <arg>      Number of partitions of the topic, default: 1
@@ -686,7 +691,6 @@ Storage Benchmark Kit
 
 Please report issues at https://github.com/kmgowda/SBK
 
-
 ```
 
 ### Add your driver to SBK Manually