Index

A B C D E F G H I L M N P R S T
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractGemLogger - Class in io.gem.logger.impl

Base class for GEM loggers built on top of SbmPrometheusLogger.

AbstractGemLogger() - Constructor for class io.gem.logger.impl.AbstractGemLogger

B

BIN_DIR - Static variable in class io.gem.config.GemConfig

String BIN_DIR = "bin".

buildBenchmark(String[], String, String, String) - Static method in class io.gem.api.impl.SbkGem

Build the Benchmark Object.

C

connection - Variable in class io.gem.api.SshSession

public SshConnection connection.

ConnectionConfig - Class in io.gem.api

Immutable SSH connection configuration used by SBK-GEM.

ConnectionConfig(String, String, String, int, String) - Constructor for class io.gem.api.ConnectionConfig

Create a connection configuration.

copy - Variable in class io.gem.config.GemConfig

Whether to copy SBK to remote nodes before running.

copyDirectory(ClientSession, String, String) - Static method in class io.gem.api.SshUtils

Recursively copy a directory to a remote path using SCP.

copyDirectoryAsync(String, String) - Method in class io.gem.api.SshSession

It copies directory of sessions but throws ConnectException if it occurs.

createSession(SshClient, ConnectionConfig, long) - Static method in class io.gem.api.SshUtils

Create and authenticate an SSH ClientSession.

createSessionAsync(long) - Method in class io.gem.api.SshSession

This method Creates Sessions.

D

delete - Variable in class io.gem.config.GemConfig

Whether to delete SBK from remote nodes after run.

DESC - Static variable in class io.gem.config.GemConfig

String DESC = "Storage Benchmark Kit - Group Execution Monitor".

E

errOutput - Variable in class io.gem.api.RemoteResponse

String errOutput.

errOutputStream - Variable in class io.gem.api.SshResponse

OutputStream errOutputStream.

F

fork - Variable in class io.gem.config.GemConfig

Whether to fork a ForkJoinPool for execution (vs fixed thread pool).

G

GemBenchmark - Interface in io.gem.api

Orchestrates a remote multi-node SBK run via SSH.

GemConfig - Class in io.gem.config

Configuration properties for SBK-GEM orchestration.

GemConfig() - Constructor for class io.gem.config.GemConfig

GemLogger - Interface in io.gem.logger

Logger contract for SBK-GEM orchestrations.

GemLoggerPackage - Class in io.gem.api

Reflection-backed package scanner for GemLogger implementations.

GemLoggerPackage(String) - Constructor for class io.gem.api.GemLoggerPackage

GemParameterOptions - Interface in io.gem.params

Interface GemParameterOptions.

GemParameters - Interface in io.gem.params

Interface GemParameters.

gempass - Variable in class io.gem.config.GemConfig

SSH password.

gemport - Variable in class io.gem.config.GemConfig

SSH port.

GemPrometheusLogger - Class in io.gem.logger.impl

Prometheus-backed GEM logger built atop SbmPrometheusLogger.

GemPrometheusLogger() - Constructor for class io.gem.logger.impl.GemPrometheusLogger

gemuser - Variable in class io.gem.config.GemConfig

SSH user name.

GetArguments - Interface in io.gem.params

Interface GetArguments.

getClasses(String) - Method in class io.gem.api.GemLoggerPackage

getConnections() - Method in interface io.gem.params.GemParameters

to get ssh connections.

getLocalHost() - Method in interface io.gem.params.GemParameters

to get local host.

getOptionsArgs() - Method in class io.gem.logger.impl.AbstractGemLogger

getOptionsArgs() - Method in class io.gem.logger.impl.GemPrometheusLogger

List of logger-specific CLI options that GEM should include when composing the remote SBK command line.

getOptionsArgs() - Method in interface io.gem.params.GetArguments

to get options provided as arguments.

getParsedArgs() - Method in class io.gem.logger.impl.AbstractGemLogger

getParsedArgs() - Method in class io.gem.logger.impl.GemPrometheusLogger

Concrete logger arguments reflecting current configuration.

getParsedArgs() - Method in interface io.gem.params.GetArguments

to get Parsed options provided as arguments.

getSbkCommand() - Method in interface io.gem.params.GemParameters

to get sbk commands.

getSbkCommand() - Method in class io.gem.params.impl.SbkGemParameters

getSbkDir() - Method in interface io.gem.params.GemParameters

to get Sbk directory.

getSbkDir() - Method in class io.gem.params.impl.SbkGemParameters

getSbmIdleSleepMilliSeconds() - Method in interface io.gem.params.GemParameters

to get SBM idle milliseconds sleep.

getSbmPort() - Method in interface io.gem.params.GemParameters

to get SBM port number.

H

host - Variable in class io.gem.api.RemoteResponse

String host.

I

io.gem.api - package io.gem.api

io.gem.api.impl - package io.gem.api.impl

io.gem.config - package io.gem.config

io.gem.logger - package io.gem.logger

io.gem.logger.impl - package io.gem.logger.impl

io.gem.main - package io.gem.main

io.gem.params - package io.gem.params

io.gem.params.impl - package io.gem.params.impl

isCopy() - Method in interface io.gem.params.GemParameters

checks if parameters are copy.

isCopy() - Method in class io.gem.params.impl.SbkGemParameters

isDelete() - Method in interface io.gem.params.GemParameters

checks if parameters are deleted.

isDelete() - Method in class io.gem.params.impl.SbkGemParameters

L

LOCAL_HOST - Static variable in class io.gem.config.GemConfig

String LOCAL_HOST = "localhost".

M

main(String[]) - Static method in class io.gem.main.SbkGemMain

This method is the main method of Sbk-Gem module.

maxIterations - Variable in class io.gem.config.GemConfig

Maximum number of iterations to wait/retry for remote operations.

N

NAME - Static variable in class io.gem.config.GemConfig

String NAME = "sbk-gem".

nodes - Variable in class io.gem.config.GemConfig

String nodes.

P

parseArgs(String[]) - Method in class io.gem.params.impl.SbkGemParameters

Parse GEM options, validate SBK directory/command, and build connection set.

printRemoteResults(RemoteResponse[], boolean) - Static method in class io.gem.api.impl.SbkGem

This method prints Remote Results.

R

remoteDir - Variable in class io.gem.config.GemConfig

Remote working directory on each host (derived from app name/version).

RemoteResponse - Class in io.gem.api

Immutable result of executing a command on a remote host.

RemoteResponse(int, String, String, String) - Constructor for class io.gem.api.RemoteResponse

Create a remote response snapshot.

remoteTimeoutSeconds - Variable in class io.gem.config.GemConfig

Timeout value used for remote operations (seconds).

returnCode - Variable in class io.gem.api.RemoteResponse

int returnCode.

returnCode - Variable in class io.gem.api.SshResponse

int returnCode.

run(String[], String, String, String) - Static method in class io.gem.api.impl.SbkGem

Run the Performance Benchmarking .

runCommand(ClientSession, String, long, SshResponse) - Static method in class io.gem.api.SshUtils

Execute a command over SSH, wiring stdout/stderr to the provided response streams.

runCommandAsync(String, Boolean, long) - Method in class io.gem.api.SshSession

This method is responsible for running commands but throws ConnectException if it occurs.

S

SBK_GEM_APP_NAME - Static variable in class io.gem.config.GemConfig

String SBK_GEM_APP_NAME = "sbk.gem.applicationName.

SBK_GEM_LOGGER_PACKAGE_NAME - Static variable in class io.gem.config.GemConfig

Default logger package to scan for GemLogger implementations.

SBK_GEM_SSH_PASSWD - Static variable in class io.gem.config.GemConfig

Environment variable name from which to read the SSH password if not provided in properties.

sbkcommand - Variable in class io.gem.config.GemConfig

SBK launcher command relative to GemConfig.sbkdir.

sbkdir - Variable in class io.gem.config.GemConfig

Local SBK application directory.

SbkGem - Class in io.gem.api.impl

SBK-GEM orchestrator entry points and utilities.

SbkGem() - Constructor for class io.gem.api.impl.SbkGem

SbkGemBenchmark - Class in io.gem.api.impl

Coordinates remote SBK execution and local SBM lifecycle.

SbkGemBenchmark(Benchmark, GemConfig, GemParameters, String) - Constructor for class io.gem.api.impl.SbkGemBenchmark

Constructor SbkGemBenchmark is responsible for initializing all values.

SbkGemMain - Class in io.gem.main

Class SbkGemMain.

SbkGemMain() - Constructor for class io.gem.main.SbkGemMain

SbkGemParameters - Class in io.gem.params.impl

GEM (Group Execution Monitor) parameters and argument parsing.

SbkGemParameters(String, String[], String[], GemConfig, int, int) - Constructor for class io.gem.params.impl.SbkGemParameters

Construct GEM parameters with defaults and register GEM options.

SshResponse - Class in io.gem.api

Mutable holder for SSH command execution streams and exit code.

SshResponse(boolean) - Constructor for class io.gem.api.SshResponse

Create response streams.

SshSession - Class in io.gem.api

Lifecycle wrapper around an SSH client/session for a single connection.

SshSession(ConnectionConfig, ExecutorService) - Constructor for class io.gem.api.SshSession

This Constructor initializes all values.

SshUtils - Class in io.gem.api

SSH utility methods for session creation, command execution, and SCP copy.

SshUtils() - Constructor for class io.gem.api.SshUtils

start() - Method in interface io.gem.api.GemBenchmark

Start the Benchmark.

start() - Method in class io.gem.api.impl.SbkGemBenchmark

stdOutput - Variable in class io.gem.api.RemoteResponse

String stdOutput.

stdOutputStream - Variable in class io.gem.api.SshResponse

OutputStream stdOutputStream.

stop() - Method in interface io.gem.api.GemBenchmark

stop/shutdown the Benchmark.

stop() - Method in class io.gem.api.impl.SbkGemBenchmark

stop() - Method in class io.gem.api.SshSession

This method is responsible for closing session and stopping the client.

T

timeoutSeconds - Variable in class io.gem.config.GemConfig

Per-iteration wait timeout used during async joins (seconds).

A B C D E F G H I L M N P R S T
All Classes and Interfaces|All Packages|Constant Field Values