Class Sbk

java.lang.Object

io.sbk.api.impl.Sbk

public final class Sbk
extends Object

Central SBK bootstrap and factory helper.

This class contains the public entry-point used by the CLI to construct and run a benchmark. It performs the following responsibilities:

• Parse and normalise command-line arguments and environment properties.
• Discover and instantiate the configured storage driver and logger using the Package discovery helpers.
• Build and return a Benchmark implementation ready to be executed.

Design notes:

• The buildBenchmark(String[], String, String, String) method performs discovery, validation and wiring: it never starts the benchmark — callers must invoke Benchmark.start() to run the workload.
• This class logs diagnostic information (SBK version, configured packages, JVM and argument details) to aid troubleshooting in test and CI environments.

Constructor Summary

Constructors

Constructor	Description
Sbk()

Method Summary

Modifier and Type	Method	Description
static @NotNull Benchmark	buildBenchmark(String[] args, String applicationName, String storagePackageName, String loggerPackageName)	Build the Benchmark Object.
static void	run(String[] args, String applicationName, String storagePackageName, String loggerPackageName)	Run the Performance Benchmarking .

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Sbk

public Sbk()

Method Details

run

public static void run(String[] args,
 String applicationName,
 String storagePackageName,
 String loggerPackageName)
                throws org.apache.commons.cli.ParseException,
IllegalArgumentException,
IOException,
InterruptedException,
ExecutionException,
TimeoutException,
InstantiationException,
ClassNotFoundException,
InvocationTargetException,
NoSuchMethodException,
IllegalAccessException

Run the Performance Benchmarking .

Parameters:

args - command line arguments.

applicationName - name of the application. will be used in the 'help' message. if it is 'null' , name 'sbk' used as default.

storagePackageName - the name of the package where storage class is available. If you pass null to this parameter, then default package name "io.sbk" is used.

loggerPackageName - Logger object to write the benchmarking results; if it is 'null' , the default Prometheus logger will be used.

Throws:

org.apache.commons.cli.ParseException - If an exception occurred while parsing command line arguments.

IllegalArgumentException - If an exception occurred due to invalid arguments.

IOException - If an exception occurred due to write or read failures.

InstantiationException - if the exception occurred due to initiation failures.

InterruptedException - If an exception occurred if the writers and readers are interrupted.

ExecutionException - If an exception occurred.

TimeoutException - If an exception occurred if an I/O operation is timed out.

ClassNotFoundException - if the supplied storage class is not found.

InvocationTargetException - if the exception occurs.

NoSuchMethodException - if the exception occurs.

IllegalAccessException - if the exception occurs.

buildBenchmark

@Contract("_, _, _, _ -> new")
@NotNull
public static @NotNull Benchmark buildBenchmark(String[] args,
 String applicationName,
 String storagePackageName,
 String loggerPackageName)
                                         throws org.apache.commons.cli.ParseException,
IllegalArgumentException,
IOException,
InstantiationException,
HelpException,
ClassNotFoundException,
InvocationTargetException,
NoSuchMethodException,
IllegalAccessException

Build the Benchmark Object.

Parameters:

args - command line arguments.

applicationName - name of the application. will be used in the 'help' message. if it is 'null' , name 'sbk' used as default.

storagePackageName - Name of the package where storage class is available. If you pass null to this parameter, then default package name "io.sbk" is used.

loggerPackageName - Logger object to write the benchmarking results; if it is 'null' , the default Prometheus logger will be used.

Returns:

Benchmark interface

Throws:

HelpException - if '-help' option is supplied.

org.apache.commons.cli.ParseException - If an exception occurred while parsing command line arguments.

IllegalArgumentException - If an exception occurred due to invalid arguments.

IOException - If an exception occurred due to write or read failures.

InstantiationException - if the exception occurred due to initiation failures.

ClassNotFoundException - If the storage class driver is not found.

InvocationTargetException - if the exception occurs.

NoSuchMethodException - if the exception occurs.

IllegalAccessException - if the exception occurs.