Package io.gem.api.impl

Class SbkGem

java.lang.Object

io.gem.api.impl.SbkGem

public final class SbkGem
extends Object

SBK-GEM orchestrator entry points and utilities.

Provides static helpers to build and run a GEM benchmark across multiple remote nodes over SSH. Responsibilities include: - discover storage and logger classes, - parse GEM/SBK parameters and logger options, - verify local/remote prerequisites (e.g., Java versions, SBK directory/command), - optionally copy SBK artifacts to remote hosts, - start SBM locally and coordinate remote SBK runs, - aggregate and print remote results.

Constructor Summary

Constructors

Constructor	Description
SbkGem()

Method Summary

Modifier and Type	Method	Description
static @NotNull GemBenchmark	buildBenchmark(String[] args, String applicationName, String storagePackageName, String loggerPackageName)	Build the Benchmark Object.
static void	printRemoteResults(@NotNull RemoteResponse[] results, boolean all)	This method prints Remote Results.
static RemoteResponse[]	run(String[] args, String applicationName, String storagePackageName, String loggerPackageName)	Run the Performance Benchmarking .

Methods inherited from class java.lang.Object

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

Constructor Details

SbkGem

public SbkGem()

Method Details

run

public static RemoteResponse[] run(String[] args,
 String applicationName,
 String storagePackageName,
 String loggerPackageName)
                            throws org.apache.commons.cli.ParseException,
IllegalArgumentException,
IOException,
InterruptedException,
InstantiationException,
ExecutionException,
TimeoutException,
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' , SbkServer is used by 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:

Array of remote responses

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.

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.

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.

buildBenchmark

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

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' , storage name is used by 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:

io.sbk.exception.HelpException - if '-help' option is supplied.

org.apache.commons.cli.ParseException - If an exception occurred while parsing command line 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.

printRemoteResults

public static void printRemoteResults(@NotNull
 @NotNull RemoteResponse[] results,
 boolean all)

This method prints Remote Results.

Parameters:

results - NotNull RemoteResponse[]

all - boolean