Merge pull request #439 from kmgowda/kmg-docs-5.3-1

bug fixes and documents update

Signed-off-by: Keshava Munegowda keshava.gowda@gmail.com

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

perl/javadoc/allclasses-index.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>All Classes and Interfaces (perl 5.2 API)</title>
+<title>All Classes and Interfaces (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="class index">
@@ -165,10 +165,14 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="col-last even-row-color all-classes-table all-classes-table-tab1">
 <div class="block">Interface PerformanceLogger.</div>
 </div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/perl/api/impl/PerformanceRecorder.html" title="class in io.perl.api.impl">PerformanceRecorder</a></div>
-<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="io/perl/api/impl/PerformanceRecorderIdleBusyWait.html" title="class in io.perl.api.impl">PerformanceRecorderIdleBusyWait</a></div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
 <div class="block">Class for Performance Recording.</div>
 </div>
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/perl/api/impl/PerformanceRecorderIdleSleep.html" title="class in io.perl.api.impl">PerformanceRecorderIdleSleep</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="io/perl/api/PeriodicRecorder.html" title="interface in io.perl.api">PeriodicRecorder</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab1">
 <div class="block">Interface for recording latencies.</div>

perl/javadoc/allpackages-index.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>All Packages (perl 5.2 API)</title>
+<title>All Packages (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="package index">

perl/javadoc/constant-values.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Constant Field Values (perl 5.2 API)</title>
+<title>Constant Field Values (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="summary of constants">

perl/javadoc/help-doc.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>API Help (perl 5.2 API)</title>
+<title>API Help (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="help">

perl/javadoc/index-all.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Index (perl 5.2 API)</title>
+<title>Index (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="index">
@@ -146,6 +146,8 @@ <h2 class="title" id="I:C">C</h2>
 <dd>
 <div class="block">Interface Channel.</div>
 </dd>
+<dt><a href="io/perl/api/PerformanceRecorder.html#channels" class="member-name-link">channels</a> - Variable in class io.perl.api.<a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></dt>
+<dd>&nbsp;</dd>
 <dt><a href="io/perl/api/impl/TotalLatencyRecordWindow.html#checkTotalWindowFullAndReset(long)" class="member-name-link">checkTotalWindowFullAndReset(long)</a> - Method in class io.perl.api.impl.<a href="io/perl/api/impl/TotalLatencyRecordWindow.html" title="class in io.perl.api.impl">TotalLatencyRecordWindow</a></dt>
 <dd>
 <div class="block">This method checks if totalWindow is full and Stop the Total Window.</div>
@@ -855,14 +857,28 @@ <h2 class="title" id="I:P">P</h2>
 <dd>
 <div class="block">Interface PerformanceLogger.</div>
 </dd>
-<dt><a href="io/perl/api/impl/PerformanceRecorder.html" class="type-name-link" title="class in io.perl.api.impl">PerformanceRecorder</a> - Class in <a href="io/perl/api/impl/package-summary.html">io.perl.api.impl</a></dt>
+<dt><a href="io/perl/api/PerformanceRecorder.html" class="type-name-link" title="class in io.perl.api">PerformanceRecorder</a> - Class in <a href="io/perl/api/package-summary.html">io.perl.api</a></dt>
+<dd>&nbsp;</dd>
+<dt><a href="io/perl/api/PerformanceRecorder.html#%3Cinit%3E(io.perl.api.PeriodicRecorder,io.perl.api.Channel%5B%5D,io.time.Time,int)" class="member-name-link">PerformanceRecorder(PeriodicRecorder, Channel[], Time, int)</a> - Constructor for class io.perl.api.<a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></dt>
+<dd>
+<div class="block">Constructor to initialize values.</div>
+</dd>
+<dt><a href="io/perl/api/impl/PerformanceRecorderIdleBusyWait.html" class="type-name-link" title="class in io.perl.api.impl">PerformanceRecorderIdleBusyWait</a> - Class in <a href="io/perl/api/impl/package-summary.html">io.perl.api.impl</a></dt>
 <dd>
 <div class="block">Class for Performance Recording.</div>
 </dd>
-<dt><a href="io/perl/api/impl/PerformanceRecorder.html#%3Cinit%3E(io.perl.api.PeriodicRecorder,io.perl.api.Channel%5B%5D,io.time.Time,int,int)" class="member-name-link">PerformanceRecorder(PeriodicRecorder, Channel[], Time, int, int)</a> - Constructor for class io.perl.api.impl.<a href="io/perl/api/impl/PerformanceRecorder.html" title="class in io.perl.api.impl">PerformanceRecorder</a></dt>
+<dt><a href="io/perl/api/impl/PerformanceRecorderIdleBusyWait.html#%3Cinit%3E(io.perl.api.PeriodicRecorder,io.perl.api.Channel%5B%5D,io.time.Time,int,int)" class="member-name-link">PerformanceRecorderIdleBusyWait(PeriodicRecorder, Channel[], Time, int, int)</a> - Constructor for class io.perl.api.impl.<a href="io/perl/api/impl/PerformanceRecorderIdleBusyWait.html" title="class in io.perl.api.impl">PerformanceRecorderIdleBusyWait</a></dt>
 <dd>
 <div class="block">Constructor to initialize values.</div>
 </dd>
+<dt><a href="io/perl/api/impl/PerformanceRecorderIdleSleep.html" class="type-name-link" title="class in io.perl.api.impl">PerformanceRecorderIdleSleep</a> - Class in <a href="io/perl/api/impl/package-summary.html">io.perl.api.impl</a></dt>
+<dd>&nbsp;</dd>
+<dt><a href="io/perl/api/impl/PerformanceRecorderIdleSleep.html#%3Cinit%3E(io.perl.api.PeriodicRecorder,io.perl.api.Channel%5B%5D,io.time.Time,int,int)" class="member-name-link">PerformanceRecorderIdleSleep(PeriodicRecorder, Channel[], Time, int, int)</a> - Constructor for class io.perl.api.impl.<a href="io/perl/api/impl/PerformanceRecorderIdleSleep.html" title="class in io.perl.api.impl">PerformanceRecorderIdleSleep</a></dt>
+<dd>
+<div class="block">Constructor to initialize values.</div>
+</dd>
+<dt><a href="io/perl/api/PerformanceRecorder.html#periodicRecorder" class="member-name-link">periodicRecorder</a> - Variable in class io.perl.api.<a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></dt>
+<dd>&nbsp;</dd>
 <dt><a href="io/perl/api/PeriodicRecorder.html" class="type-name-link" title="interface in io.perl.api">PeriodicRecorder</a> - Interface in <a href="io/perl/api/package-summary.html">io.perl.api</a></dt>
 <dd>
 <div class="block">Interface for recording latencies.</div>
@@ -1109,7 +1125,15 @@ <h2 class="title" id="I:R">R</h2>
 <dd>
 <div class="block">Run the CQ Perl.</div>
 </dd>
-<dt><a href="io/perl/api/impl/PerformanceRecorder.html#run(long,long)" class="member-name-link">run(long, long)</a> - Method in class io.perl.api.impl.<a href="io/perl/api/impl/PerformanceRecorder.html" title="class in io.perl.api.impl">PerformanceRecorder</a></dt>
+<dt><a href="io/perl/api/impl/PerformanceRecorderIdleBusyWait.html#run(long,long)" class="member-name-link">run(long, long)</a> - Method in class io.perl.api.impl.<a href="io/perl/api/impl/PerformanceRecorderIdleBusyWait.html" title="class in io.perl.api.impl">PerformanceRecorderIdleBusyWait</a></dt>
+<dd>
+<div class="block">Method run.</div>
+</dd>
+<dt><a href="io/perl/api/impl/PerformanceRecorderIdleSleep.html#run(long,long)" class="member-name-link">run(long, long)</a> - Method in class io.perl.api.impl.<a href="io/perl/api/impl/PerformanceRecorderIdleSleep.html" title="class in io.perl.api.impl">PerformanceRecorderIdleSleep</a></dt>
+<dd>
+<div class="block">Method run.</div>
+</dd>
+<dt><a href="io/perl/api/PerformanceRecorder.html#run(long,long)" class="member-name-link">run(long, long)</a> - Method in class io.perl.api.<a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></dt>
 <dd>
 <div class="block">Method run.</div>
 </dd>
@@ -1158,6 +1182,10 @@ <h2 class="title" id="I:S">S</h2>
 <dd>
 <div class="block"><code>String slc2Name</code>.</div>
 </dd>
+<dt><a href="io/perl/config/PerlConfig.html#sleepMS" class="member-name-link">sleepMS</a> - Variable in class io.perl.config.<a href="io/perl/config/PerlConfig.html" title="class in io.perl.config">PerlConfig</a></dt>
+<dd>
+<div class="block"><code>int sleepMS</code>.</div>
+</dd>
 <dt><a href="io/perl/logger/impl/DefaultPrometheusLogger.html#start()" class="member-name-link">start()</a> - Method in class io.perl.logger.impl.<a href="io/perl/logger/impl/DefaultPrometheusLogger.html" title="class in io.perl.logger.impl">DefaultPrometheusLogger</a></dt>
 <dd>
 <div class="block">Starts this server in a new background thread.</div>
@@ -1240,6 +1268,8 @@ <h2 class="title" id="I:T">T</h2>
 <dd>
 <div class="block"><code>Time time</code>.</div>
 </dd>
+<dt><a href="io/perl/api/PerformanceRecorder.html#time" class="member-name-link">time</a> - Variable in class io.perl.api.<a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></dt>
+<dd>&nbsp;</dd>
 <dt><a href="io/time/Time.html" class="type-name-link" title="interface in io.time">Time</a> - Interface in <a href="io/time/package-summary.html">io.time</a></dt>
 <dd>
 <div class="block">Interface Time.</div>
@@ -1389,6 +1419,8 @@ <h2 class="title" id="I:W">W</h2>
 <dd>
 <div class="block"><code>LatencyRecordWindow window</code>.</div>
 </dd>
+<dt><a href="io/perl/api/PerformanceRecorder.html#windowIntervalMS" class="member-name-link">windowIntervalMS</a> - Variable in class io.perl.api.<a href="io/perl/api/PerformanceRecorder.html" title="class in io.perl.api">PerformanceRecorder</a></dt>
+<dd>&nbsp;</dd>
 <dt><a href="io/perl/api/impl/TotalLatencyRecordWindow.html#windowLogger" class="member-name-link">windowLogger</a> - Variable in class io.perl.api.impl.<a href="io/perl/api/impl/TotalLatencyRecordWindow.html" title="class in io.perl.api.impl">TotalLatencyRecordWindow</a></dt>
 <dd>
 <div class="block"><code>Print windowLogger</code>.</div>

perl/javadoc/index.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Overview (perl 5.2 API)</title>
+<title>Overview (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="package index">
@@ -47,7 +47,7 @@
 <div class="flex-content">
 <main role="main">
 <div class="header">
-<h1 class="title">perl 5.2 API</h1>
+<h1 class="title">perl 5.3 API</h1>
 </div>
 <div id="all-packages-table">
 <div class="caption"><span>Packages</span></div>

perl/javadoc/io/perl/api/Channel.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Channel (perl 5.2 API)</title>
+<title>Channel (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: io.perl.api, interface: Channel">

perl/javadoc/io/perl/api/GetPerlChannel.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>GetPerlChannel (perl 5.2 API)</title>
+<title>GetPerlChannel (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: io.perl.api, interface: GetPerlChannel">

perl/javadoc/io/perl/api/LatencyPercentiles.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>LatencyPercentiles (perl 5.2 API)</title>
+<title>LatencyPercentiles (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: io.perl.api, class: LatencyPercentiles">

perl/javadoc/io/perl/api/LatencyRecord.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>LatencyRecord (perl 5.2 API)</title>
+<title>LatencyRecord (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: io.perl.api, class: LatencyRecord">

perl/javadoc/io/perl/api/LatencyRecordWindow.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>LatencyRecordWindow (perl 5.2 API)</title>
+<title>LatencyRecordWindow (perl 5.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: io.perl.api, class: LatencyRecordWindow">