Index

A B C D E F G H I L M N O P R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractCallbackReader<T> - Class in io.sbk.api

Abstract helper for callback-style readers.

AbstractCallbackReader() - Constructor for class io.sbk.api.AbstractCallbackReader

Creates a callback-based reader whose runtime state is supplied by AbstractCallbackReader.initialize(Worker, long, long, DataType, Time, Callback).

AbstractRWLogger - Class in io.sbk.logger.impl

Base implementation of RWLogger providing shared read/write request accounting, periodic aggregation, and printing helpers.

AbstractRWLogger() - Constructor for class io.sbk.logger.impl.AbstractRWLogger

Creates a logger with empty writer, reader, and request counters.

Action - Enum Class in io.sbk.action

enum Action { Writing, Reading, Write_Reading, Write_OnlyReading, Read_Writing, Read_OnlyWriting}.

ActionParameter - Interface in io.sbk.params

Supplies the benchmark Action (READ/WRITE variants) selected via CLI.

addArgs(InputOptions) - Method in interface io.sbk.api.Storage

Add the driver specific command line arguments.

addArgs(InputOptions) - Method in class io.sbk.logger.impl.AbstractRWLogger

addArgs(InputOptions) - Method in class io.sbk.logger.impl.CSVLogger

addArgs(InputOptions) - Method in class io.sbk.logger.impl.GrpcLogger

Add SBM host/port options and load defaults from sbmhost.properties.

addArgs(InputOptions) - Method in class io.sbk.logger.impl.PrometheusLogger

addArgs(InputOptions) - Method in class io.sbk.logger.impl.WebLogger

addArgs(InputOptions) - Method in interface io.sbk.logger.Logger

Add the Metric type specific command line arguments.

addArgs(InputOptions) - Method in class io.sbk.webconsole.WebConsoleLoggerSupport

Adds the Local Web Console command-line options.

addOption(String, boolean, String) - Method in class io.sbk.params.impl.SbkInputOptions

addOption(String, boolean, String) - Method in interface io.sbk.params.InputOptions

Add the driver specific command line arguments.

allocate(int) - Method in interface io.sbk.data.DataType

allocate the data.

allocate(int) - Method in class io.sbk.data.impl.ByteArray

Create byte array data.

allocate(int) - Method in class io.sbk.data.impl.NioByteBuffer

Create byte buffer.

allocate(int) - Method in class io.sbk.data.impl.ProtoBufByteString

Create byte array data.

allocate(int) - Method in class io.sbk.data.impl.SbkString

Create byte array data.

appendResultString(StringBuilder, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.AbstractRWLogger

Appends a complete read/write benchmark result.

appendWriteAndReadRequests(StringBuilder, long, double, long, double, long, double, long, double) - Method in class io.sbk.logger.impl.AbstractRWLogger

Appends write- and read-request throughput values.

appendWriteAndReadRequestsPending(StringBuilder, long, long, long, long, long, long) - Method in class io.sbk.logger.impl.AbstractRWLogger

Appends pending request and response counts.

appendWriteAndReadTimeoutEvents(StringBuilder, long, double, long, double) - Method in class io.sbk.logger.impl.AbstractRWLogger

Appends write and read timeout counters.

appendWritesAndReaders(StringBuilder, int, int, int, int) - Method in class io.sbk.logger.impl.AbstractRWLogger

Appends writer and reader concurrency counts.

ApplicationShutdownHook - Class in io.sbk.utils

Registers a bounded JVM shutdown hook for an SBK application.

apply(long, long) - Method in interface io.sbk.api.BiConsumer

Apply the Benchmark.

ARG_PREFIX - Static variable in class io.sbk.config.Config

ARG_PREFIX = "-";.

args - Variable in class io.sbk.params.YmlMap

Key-value pairs that will be transformed into CLI arguments.

argsToMap(String[], boolean) - Static method in class io.sbk.utils.SbkUtils

Converts option/value argument pairs to an ordered map.

AsyncReader<T> - Interface in io.sbk.api

Interface for Asynchronous Readers.

B

Benchmark - Interface in io.sbk.api

Interface for Benchmark.

BiConsumer - Interface in io.sbk.api

Functional-style BiConsumer used by internal harness code to represent a benchmark invocation that accepts a time budget and a records limit.

BOARD_NAME_OPTION - Static variable in class io.sbk.webconsole.WebConsoleLoggerSupport

Web console benchmark-board name CLI option.

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

Build the Benchmark Object.

ByteArray - Class in io.sbk.data.impl

Class for processing byte[] data.

ByteArray() - Constructor for class io.sbk.data.impl.ByteArray

Creates a byte-array data generator.

bytes - Variable in class io.sbk.api.Status

Number of processed bytes.

C

Callback<T> - Interface in io.sbk.api

Callback interface used by callback-driven drivers to receive data and optionally report per-record benchmarking metrics.

channelForceShutdownTimeoutSeconds - Variable in class io.sbk.logger.SbmHostConfig

Forced channel shutdown timeout in seconds.

channelShutdownTimeoutSeconds - Variable in class io.sbk.logger.SbmHostConfig

Graceful channel shutdown timeout in seconds.

CLASS_OPTION - Static variable in class io.sbk.config.Config

CLASS_OPTION = "class";.

CLASS_OPTION_ARG - Static variable in class io.sbk.config.Config

CLASS_OPTION_ARG = ARG_PREFIX + CLASS_OPTION;.

close() - Method in class io.sbk.api.AbstractCallbackReader

Close the CallBack Reader.

close() - Method in interface io.sbk.api.AsyncReader

Close the Reader.

close() - Method in interface io.sbk.api.DataReader

ß Close the Reader.

close() - Method in interface io.sbk.api.DataWriter

Close the Writer.

close() - Method in interface io.sbk.api.Reader

Close the Reader.

close() - Method in interface io.sbk.api.Writer

Close the Writer.

close() - Method in class io.sbk.webconsole.WebConsoleLoggerSupport

close(ParsedOptions) - Method in class io.sbk.logger.impl.AbstractRWLogger

close(ParsedOptions) - Method in class io.sbk.logger.impl.CSVLogger

close(ParsedOptions) - Method in class io.sbk.logger.impl.GrpcLogger

Close the logger, unregister the client, and shutdown the gRPC channel.

close(ParsedOptions) - Method in class io.sbk.logger.impl.PrometheusLogger

Close the logger and stop the HTTP server if it was started.

close(ParsedOptions) - Method in class io.sbk.logger.impl.WebLogger

close(ParsedOptions) - Method in interface io.sbk.logger.Logger

Close the Logger.

closeStorage(ParameterOptions) - Method in interface io.sbk.api.Storage

Close the Storage device / client.

complete() - Method in class io.sbk.api.AbstractCallbackReader

Default Implementation complete the read.

COMPONENT_CHARACTERS - Static variable in class io.sbp.config.SbpFailureLimits

Maximum component-name characters accepted by SBM.

COMPONENT_TAG - Static variable in class io.sbk.logger.impl.SbkPrometheusServer

Common metric tag identifying the process that exports the metrics.

config - Variable in class io.sbk.params.impl.SbkYalParameters

YAML launcher configuration populated during parsing.

Config - Class in io.sbk.config

Class Config.

Config() - Constructor for class io.sbk.config.Config

Creates an SBK constants container.

consume(Object) - Method in class io.sbk.api.impl.SbkCallbackReader

Deprecated.

consume(T) - Method in interface io.sbk.api.Callback

Consume the data.

context - Variable in class io.sbk.logger.MetricsConfig

HTTP path under which metrics are served, such as /metrics.

control(long, double) - Method in class io.sbk.api.impl.SbkRateController

Blocks for small amounts of time to achieve target Throughput/events per sec.

control(long, double) - Method in interface io.sbk.api.RateController

Blocks for small amounts of time to achieve target Throughput/events per sec.

CountReaders - Interface in io.sbk.logger

Interface for tracking the count of active readers in the benchmarking system.

CountRW - Interface in io.sbk.logger

Combined interface for tracking both readers and writers in the benchmarking system.

CountWriters - Interface in io.sbk.logger

Interface for tracking the count of active writers in the benchmarking system.

create(int) - Method in interface io.sbk.data.DataType

Create the data with payload content.

create(int) - Method in class io.sbk.data.impl.ByteArray

Create byte array data and fill the random data.

create(int) - Method in class io.sbk.data.impl.NioByteBuffer

Create byte buffer data and will with random data.

create(int) - Method in class io.sbk.data.impl.ProtoBufByteString

Create byte array data and fill the random data.

create(int) - Method in class io.sbk.data.impl.SbkString

Create byte array data and fill the random data.

createReader(int, ParameterOptions) - Method in interface io.sbk.api.Storage

Create a Single Reader / Consumer.

createWriter(int, ParameterOptions) - Method in interface io.sbk.api.Storage

Create a Single Data Writer / Producer.

CSVLogger - Class in io.sbk.logger.impl

Class for recoding/printing results to a CSV file called `out.csv`.

CSVLogger() - Constructor for class io.sbk.logger.impl.CSVLogger

calls its super class SystemLogger.

D

DataReader<T> - Interface in io.sbk.api

Abstraction for data-reading capabilities used by SBK drivers.

DataRecordsReader<T> - Interface in io.sbk.api

Interface for Data Record Readers.

DataRecordsReader.RecordTime<T> - Interface in io.sbk.api

interface RecordTime.

DataRecordsReader.RecordTimeRequests<T> - Interface in io.sbk.api

Records timed reads and forwards request metrics to an RW logger.

DataRecordsWriter<T> - Interface in io.sbk.api

Higher-level writer abstraction that exposes methods for recording write metrics and provides default harness-driven write workloads.

DataType<T> - Interface in io.sbk.data

Interface for Data Type operations.

DataWriter<T> - Interface in io.sbk.api

Interface for Basic Data Writers.

decrementReaders() - Method in interface io.sbk.logger.CountReaders

Decrements the count of active readers.

decrementReaders() - Method in class io.sbk.logger.impl.AbstractRWLogger

decrementWriters() - Method in interface io.sbk.logger.CountWriters

Decrements the count of active writers.

decrementWriters() - Method in class io.sbk.logger.impl.AbstractRWLogger

defaultIdleSleepMillis - Variable in class io.sbk.config.SbkConfig

Default worker idle sleep in milliseconds.

defaultOperationTimeoutMillis - Variable in class io.sbk.config.SbkRuntimeConfig

Default storage-operation timeout in milliseconds.

defaultReaders - Variable in class io.sbk.config.SbkConfig

Default reader count when the option is omitted.

defaultReaderStep - Variable in class io.sbk.config.SbkConfig

Default reader ramp step.

defaultReaderStepSeconds - Variable in class io.sbk.config.SbkConfig

Default reader ramp interval in seconds.

defaultReadOnly - Variable in class io.sbk.config.SbkConfig

Default read-only mode for mixed writer/reader benchmarks.

defaultRecords - Variable in class io.sbk.config.SbkConfig

Default record count when the option is omitted.

defaultRecordSize - Variable in class io.sbk.config.SbkConfig

Default record size when the option is omitted.

defaultSyncRecords - Variable in class io.sbk.config.SbkConfig

Default records per sync when the option is omitted.

defaultThreadType - Variable in class io.sbk.config.SbkConfig

Default thread selector: p, f, or v.

defaultThroughput - Variable in class io.sbk.config.SbkConfig

Default throughput selector when the option is omitted.

defaultWriters - Variable in class io.sbk.config.SbkConfig

Default writer count when the option is omitted.

defaultWriterStep - Variable in class io.sbk.config.SbkConfig

Default writer ramp step.

defaultWriterStepSeconds - Variable in class io.sbk.config.SbkConfig

Default writer ramp interval in seconds.

DESC - Static variable in class io.sbk.config.Config

DESC = "Storage Benchmark Kit";.

DISABLE_STRING - Static variable in class io.sbk.logger.impl.CSVLogger

DISABLE_STRING = "no".

E

endTime - Variable in class io.sbk.api.Status

Operation completion timestamp.

equals(Object) - Method in record class io.sbk.logger.impl.PrometheusLinks.Link

Indicates whether some other object is "equal to" this one.

ExitCode - Class in io.sbk.config

Process exit statuses shared by SBK suite launchers.

F

FAILURE - Static variable in class io.sbk.config.ExitCode

Runtime or operational failure.

failureReportTimeoutSeconds - Variable in class io.sbk.logger.SbmHostConfig

Terminal failure-report deadline in seconds.

FILE_OPTION - Static variable in class io.sbk.config.YalConfig

FILE_OPTION = "FILE_OPTION";.

FILE_OPTION_ARG - Static variable in class io.sbk.config.YalConfig

FILE_OPTION_ARG = ARG_PREFIX + FILE_OPTION;.

forcedShutdownGraceSeconds - Variable in class io.sbk.config.SbkRuntimeConfig

Grace period after the requested benchmark duration.

ForkJoin - Enum constant in enum class io.sbk.thread.ThreadType

ForkJoin threads - Work-stealing threads for parallel algorithms.

G

GENERATED_DATA_ALPHABET_SIZE - Static variable in interface io.sbk.data.DataType

Number of uppercase ASCII characters used for generated payloads.

GENERATED_DATA_ASCII_BASE - Static variable in interface io.sbk.data.DataType

ASCII code of the first uppercase character used for generated payloads.

genericRecordsReader(Worker, long, DataType, Time, DataRecordsReader.RecordTime) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading given number of records.

genericRecordsReader(Worker, long, DataType, Time, DataRecordsReader.RecordTimeRequests, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading given number of records.

genericRecordsReaderRateControl(Worker, long, DataType, Time, RateController, DataRecordsReader.RecordTime) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader with Rate controlled.

genericRecordsReaderRateControl(Worker, long, DataType, Time, RateController, DataRecordsReader.RecordTimeRequests, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader with Rate controlled.

genericRecordsTimeReader(Worker, long, DataType, Time, DataRecordsReader.RecordTime) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading events/records for specific time duration.

genericRecordsTimeReader(Worker, long, DataType, Time, DataRecordsReader.RecordTimeRequests, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading events/records for specific time duration.

genericRecordsTimeReaderRateControl(Worker, long, DataType, Time, RateController, DataRecordsReader.RecordTime) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading events/records with Rate Controls.

genericRecordsTimeReaderRateControl(Worker, long, DataType, Time, RateController, DataRecordsReader.RecordTimeRequests, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading events/records with Rate Controls.

get() - Static method in class io.sbk.config.SbkConfig

Returns the validated bundled SBK configuration.

get() - Static method in class io.sbk.config.SbkRuntimeConfig

Returns the validated bundled runtime configuration.

getAction() - Method in class io.sbk.logger.impl.AbstractRWLogger

Returns the benchmark action.

getAction() - Method in interface io.sbk.params.ActionParameter

Get the selected benchmark action.

getArgValue(String[], String) - Static method in class io.sbk.utils.SbkUtils

Finds the value following an option.

getClass(String) - Method in class io.sbk.api.Package

Instantiates a discovered implementation by simple class name.

getClasses(String) - Method in class io.sbk.api.Package

Get the set of Available Storage classes.

getClasses(String) - Method in class io.sbk.api.RWLoggerPackage

getClasses(String) - Method in class io.sbk.api.StoragePackage

Get the set of Available Storage classes.

getClassName(String[]) - Static method in class io.sbk.utils.SbkUtils

Returns the selected storage class name.

getClassNames() - Method in class io.sbk.api.Package

Returns discovered simple class names in case-insensitive sort order.

getConfiguredMaxRequestIds() - Method in class io.sbk.logger.impl.AbstractRWLogger

Returns the configured request-counter ID dimension limit.

getCsvFile() - Method in class io.sbk.logger.impl.CSVLogger

Returns the configured CSV output path.

getDataType() - Method in interface io.sbk.api.Storage

Default implementation to create a payload or data to write/read.

getFileName() - Method in class io.sbk.params.impl.SbkYalParameters

getFileName() - Method in interface io.sbk.params.YalParameters

Get the configured YAML file name.

getFileOptionDescription() - Method in class io.sbk.params.impl.SbkYalParameters

Build description text for the -file option including the default path.

getHelpText() - Method in class io.sbk.params.impl.SbkInputOptions

Build and return the formatted help text for all registered options.

getHelpText() - Method in interface io.sbk.params.ParsedOptions

Get the -help output.

getIdleSleepMilliSeconds() - Method in interface io.sbk.params.Parameters

get duration idle sleep in Milliseconds.

getLoggerConfigStream() - Method in class io.sbk.logger.impl.AbstractRWLogger

Opens the default logger configuration resource.

getLoggerName(String[]) - Static method in class io.sbk.utils.SbkUtils

Returns the selected logger name.

getMaxReaderIDs() - Method in class io.sbk.logger.impl.AbstractRWLogger

getMaxReaderIDs() - Method in interface io.sbk.logger.ReadRequestsLogger

Maximum number of reader IDs the logger expects to track.

getMaxReaderIDs() - Method in interface io.sbk.logger.RWLogger

Default method to indicate to record read requests or not.

getMaxReadersCount() - Method in class io.sbk.logger.impl.AbstractRWLogger

Returns the maximum observed reader count.

getMaxWriterIDs() - Method in class io.sbk.logger.impl.AbstractRWLogger

getMaxWriterIDs() - Method in interface io.sbk.logger.RWLogger

Default method to indicate to record write requests or not.

getMaxWriterIDs() - Method in interface io.sbk.logger.WriteRequestsLogger

Maximum number of writer IDs the logger expects to track.

getMaxWritersCount() - Method in class io.sbk.logger.impl.AbstractRWLogger

Returns the maximum observed writer count.

getMetricsConfig() - Method in class io.sbk.logger.impl.PrometheusLogger

Returns the active metrics configuration.

getMetricsConfigStream() - Method in class io.sbk.logger.impl.PrometheusLogger

Opens the bundled Prometheus metrics configuration.

getOptionsArgs() - Method in class io.sbk.webconsole.WebConsoleLoggerSupport

Returns web console option names, including the command-line prefix.

getOptionValue(String) - Method in class io.sbk.params.impl.SbkInputOptions

getOptionValue(String) - Method in interface io.sbk.params.ParsedOptions

Retrieve the Option matching the parameter name specified.

getOptionValue(String, String) - Method in class io.sbk.params.impl.SbkInputOptions

getOptionValue(String, String) - Method in interface io.sbk.params.ParsedOptions

Retrieve the Option matching the parameter name specified.

getParsedArgs() - Method in class io.sbk.webconsole.WebConsoleLoggerSupport

Returns the current web console option/value pairs for forwarding to SBM.

getPerlConfig() - Method in class io.sbk.config.SbkConfig

Returns the validated PerL settings loaded from the SBK PerL properties resource.

getPrintingIntervalSeconds() - Method in class io.sbk.logger.impl.AbstractRWLogger

getPrintOptionDescription() - Method in class io.sbk.params.impl.SbkYalParameters

Build description text for the -print option.

getPrometheusRWMetricsServer() - Method in class io.sbk.logger.impl.PrometheusLogger

Creates the Prometheus server used to export read/write metrics.

getReadersCount() - Method in class io.sbk.logger.impl.AbstractRWLogger

Returns the current reader count.

getReadersCount() - Method in interface io.sbk.params.Parameters

Number of Readers/Consumers.

getReadersStep() - Method in interface io.sbk.params.Parameters

get the number of readers / step to increase.

getReadersStepSeconds() - Method in interface io.sbk.params.Parameters

get duration of readers step in seconds.

getRecordSize() - Method in interface io.sbk.params.Parameters

Size of the record/event to read or write.

getRecordsPerSec() - Method in interface io.sbk.params.Parameters

Number of records/events to write/read per Second.

getRecordsPerSync() - Method in interface io.sbk.params.Parameters

Number of records/events to write/read per single flush/sync.

getStorageName() - Method in class io.sbk.logger.impl.AbstractRWLogger

Returns the configured storage name.

getThreadType() - Method in interface io.sbk.params.ThreadTypeParameter

Gets the thread type to be used for benchmark execution.

getTime() - Method in class io.sbk.logger.impl.AbstractRWLogger

Returns the configured time source.

getTime(byte[]) - Method in class io.sbk.data.impl.ByteArray

Get the time of data.

getTime(ByteString) - Method in class io.sbk.data.impl.ProtoBufByteString

Get the time of data.

getTime(String) - Method in class io.sbk.data.impl.SbkString

Get the time of data.

getTime(ByteBuffer) - Method in class io.sbk.data.impl.NioByteBuffer

Get the time of data.

getTime(T) - Method in interface io.sbk.data.DataType

Get the time of data.

getTimeoutMS() - Method in interface io.sbk.params.Parameters

Time out for data to read.

getTimeStamp(long) - Method in class io.sbk.logger.impl.CSVLogger

Formats a report timestamp in the local time zone.

getTimeStamp(long) - Method in class io.sbk.logger.impl.GrpcLogger

Formats a report timestamp in the local time zone.

getTimeStamp(long) - Method in class io.sbk.logger.impl.PrometheusLogger

Formats a report timestamp in the local time zone.

getTimeStamp(long) - Method in class io.sbk.logger.impl.Sl4jLogger

Formats a report timestamp in the local time zone.

getTimeStamp(long) - Method in class io.sbk.logger.impl.SystemLogger

Formats a report timestamp in the local time zone.

getTimeStamp(long) - Method in class io.sbk.logger.impl.WebLogger

Formats a report timestamp in the local time zone.

getTotalRecords() - Method in interface io.sbk.params.Parameters

Get the Total Number of records to read/writer.

getTotalSecondsToRun() - Method in interface io.sbk.params.Parameters

Get the execution time in seconds.

getVersion() - Static method in class io.sbp.api.Sbp

Loads the protocol version from the bundled properties resource.

getWriteReadMinSize() - Method in interface io.sbk.data.DataType

Get minimum Write and Read Data Size.

getWriteReadMinSize() - Method in class io.sbk.data.impl.ByteArray

Get minimum Write and Read Data Size.

getWriteReadMinSize() - Method in class io.sbk.data.impl.NioByteBuffer

Get minimum Write and Read Data Size.

getWriteReadMinSize() - Method in class io.sbk.data.impl.ProtoBufByteString

Get minimum Write and Read Data Size.

getWriteReadMinSize() - Method in class io.sbk.data.impl.SbkString

getWritersCount() - Method in class io.sbk.logger.impl.AbstractRWLogger

Returns the current writer count.

getWritersCount() - Method in interface io.sbk.params.Parameters

Number of Writers/Producers.

getWritersStep() - Method in interface io.sbk.params.Parameters

get the number of writers / step to increase.

getWritersStepSeconds() - Method in interface io.sbk.params.Parameters

get duration of writers step in seconds.

getYmlArgs(String, Class) - Static method in class io.sbk.params.YmlMap

Read a YAML file and convert its args map into a CLI argument array.

GrpcLogger - Class in io.sbk.logger.impl

Streams exact SBK latency frequencies and request counters to an SBM aggregator.

GrpcLogger() - Constructor for class io.sbk.logger.impl.GrpcLogger

Construct a gRPC logger.

H

hasArg(String[], String) - Static method in class io.sbk.utils.SbkUtils

Tests whether an argument is present.

hashCode() - Method in record class io.sbk.logger.impl.PrometheusLinks.Link

Returns a hash code value for this object.

hasHelp(String[]) - Static method in class io.sbk.utils.SbkUtils

Tests whether the help option is present.

hasOption(String) - Method in class io.sbk.params.impl.SbkInputOptions

hasOption(String) - Method in interface io.sbk.params.InputOptions

Returns whether the named Option exists.

hasOptionValue(String) - Method in class io.sbk.params.impl.SbkInputOptions

hasOptionValue(String) - Method in interface io.sbk.params.ParsedOptions

Returns whether the named Option has the value after parsing.

hasVersion(String[]) - Static method in class io.sbk.utils.SbkUtils

Tests whether either version option is present.

HELP_OPTION - Static variable in class io.sbk.config.Config

HELP_OPTION = "help";.

HELP_OPTION_ARG - Static variable in class io.sbk.config.Config

HELP_OPTION_ARG = ARG_PREFIX + HELP_OPTION;.

HelpException - Exception Class in io.sbk.exception

class HelpException.

HelpException(String) - Constructor for exception class io.sbk.exception.HelpException

this.helpText = helpText.

host - Variable in class io.sbk.logger.SbmHostConfig

Hostname or IP address of the SBM server.

I

id - Variable in class io.sbk.api.Worker

Worker identifier assigned by the benchmark harness.

incrementReaders() - Method in interface io.sbk.logger.CountReaders

Increments the count of active readers.

incrementReaders() - Method in class io.sbk.logger.impl.AbstractRWLogger

incrementWriters() - Method in interface io.sbk.logger.CountWriters

Increments the count of active writers.

incrementWriters() - Method in class io.sbk.logger.impl.AbstractRWLogger

initialize(Worker, long, long, DataType, Time, Callback) - Method in class io.sbk.api.AbstractCallbackReader

Default Implementation to initialize the callback reader.

InputOptions - Interface in io.sbk.params

Builder/registry for supported command-line options before parsing.

InputParameterOptions - Interface in io.sbk.params

Composite interface bundling option registration, parsing, and typed parameter access.

INVALID_ARGUMENT - Static variable in class io.sbk.config.ExitCode

Invalid command-line arguments.

INVALID_VERSION - Static variable in class io.sbp.config.SbpVersion

Value used when no valid version has been loaded.

io.sbk.action - package io.sbk.action

io.sbk.api - package io.sbk.api

io.sbk.api.impl - package io.sbk.api.impl

io.sbk.config - package io.sbk.config

io.sbk.data - package io.sbk.data

io.sbk.data.impl - package io.sbk.data.impl

io.sbk.exception - package io.sbk.exception

io.sbk.logger - package io.sbk.logger

io.sbk.logger.impl - package io.sbk.logger.impl

io.sbk.main - package io.sbk.main

io.sbk.params - package io.sbk.params

io.sbk.params.impl - package io.sbk.params.impl

io.sbk.system - package io.sbk.system

io.sbk.thread - package io.sbk.thread

io.sbk.utils - package io.sbk.utils

io.sbk.webconsole - package io.sbk.webconsole

io.sbp.api - package io.sbp.api

io.sbp.config - package io.sbp.config

isCsvEnable() - Method in class io.sbk.logger.impl.CSVLogger

Reports whether CSV output is enabled.

isCsvWriterClosed() - Method in class io.sbk.logger.impl.CSVLogger

Reports whether the CSV writer is closed or has not been opened.

isEmpty() - Method in class io.sbk.api.Package

Reports whether discovery found no implementations.

isMpscQueueEnabled() - Method in interface io.sbk.params.Parameters

Return whether PerL uses the intrusive timestamp MPSC queue.

isReadRequestsEnabled() - Method in class io.sbk.logger.impl.AbstractRWLogger

Reports whether read-request metrics are enabled.

isWriteRequestsEnabled() - Method in class io.sbk.logger.impl.AbstractRWLogger

Reports whether write-request metrics are enabled.

L

label() - Method in record class io.sbk.logger.impl.PrometheusLinks.Link

Returns the value of the label record component.

latencyTimeUnit - Variable in class io.sbk.logger.MetricsConfig

Time unit used to publish latency metrics.

length(byte[]) - Method in class io.sbk.data.impl.ByteArray

Get the size of the given data in terms of number of bytes for writers.

length(ByteString) - Method in class io.sbk.data.impl.ProtoBufByteString

Get the size of the given data in terms of number of bytes for writers.

length(String) - Method in class io.sbk.data.impl.SbkString

Get the size of the given data in terms of number of bytes for writers.

length(ByteBuffer) - Method in class io.sbk.data.impl.NioByteBuffer

Get the size of the given data in terms of number of bytes, for writers.

length(T) - Method in interface io.sbk.data.DataType

Get the size of the given data in terms of number of bytes.

Link(String, URI) - Constructor for record class io.sbk.logger.impl.PrometheusLinks.Link

Creates an instance of a Link record class.

loadPerlConfig() - Static method in class io.sbk.params.impl.SbkParameters

Load the PerL defaults bundled with the SBK application.

localLinks(int, String) - Static method in class io.sbk.logger.impl.PrometheusLinks

Returns all locally discoverable URLs for a Prometheus endpoint.

log - Static variable in class io.sbk.system.Printer

Logger used by SBK framework components.

log(String, MetricsConfig) - Static method in class io.sbk.logger.impl.PrometheusLinks

Prints all locally discoverable URLs for a running Prometheus endpoint.

Logger - Interface in io.sbk.logger

Primary logging interface for SBK benchmarks to configure, open, and close metrics reporting.

LOGGER_OPTION - Static variable in class io.sbk.config.Config

LOGGER_OPTION = "out";.

LOGGER_OPTION_ARG - Static variable in class io.sbk.config.Config

LOGGER_OPTION_ARG = ARG_PREFIX + LOGGER_OPTION;.

LoggerConfig - Class in io.sbk.logger

Configuration model for logger behavior and latency bounds.

LoggerConfig() - Constructor for class io.sbk.logger.LoggerConfig

Creates an empty logger configuration for property binding.

M

major - Variable in class io.sbp.config.SbpVersion

Protocol major version.

mapToArgs(Map, boolean) - Static method in class io.sbk.utils.SbkUtils

Converts ordered option/value mappings to an argument array.

maximumPendingBatches - Variable in class io.sbk.logger.SbmHostConfig

Maximum number of immutable batches waiting for the gRPC sender.

maxLatency - Variable in class io.sbk.logger.LoggerConfig

Default maximum latency bound expressed in LoggerConfig.timeUnit.

maxRecordSizeMB - Variable in class io.sbk.logger.SbmHostConfig

Maximum record payload size in MB when sending latencies.

maxRequestIds - Variable in class io.sbk.logger.LoggerConfig

Maximum request-counter ID dimensions used by aggregation loggers.

mergeArgs(String[], String[]) - Static method in class io.sbk.utils.SbkUtils

Merges two option/value arrays, with the second array taking precedence.

MESSAGE_CHARACTERS - Static variable in class io.sbp.config.SbpFailureLimits

Maximum failure-message characters accepted by SBM.

MESSAGE_PREFIX_CHARACTERS - Static variable in class io.sbp.config.SbpFailureLimits

Prefix retained when an oversized diagnostic is truncated.

MetricsConfig - Class in io.sbk.logger

Configuration for metrics exporters (e.g., Prometheus).

MetricsConfig() - Constructor for class io.sbk.logger.MetricsConfig

Creates an empty metrics configuration for property binding.

minLatency - Variable in class io.sbk.logger.LoggerConfig

Default minimum latency bound expressed in LoggerConfig.timeUnit.

minor - Variable in class io.sbp.config.SbpVersion

Protocol minor version.

MPSC_QUEUE_OPTION - Static variable in class io.sbk.params.impl.SbkParameters

CLI option selecting the intrusive or JDK timestamp queue.

N

NAME - Static variable in class io.sbk.config.Config

NAME = "sbk";.

NioByteBuffer - Class in io.sbk.data.impl

Class for processing ByteBuffer data.

NioByteBuffer() - Constructor for class io.sbk.data.impl.NioByteBuffer

Creates a direct-byte-buffer data generator.

O

open(ParsedOptions, String, Action, Time) - Method in class io.sbk.logger.impl.AbstractRWLogger

open(ParsedOptions, String, Action, Time) - Method in class io.sbk.logger.impl.CSVLogger

open(ParsedOptions, String, Action, Time) - Method in class io.sbk.logger.impl.GrpcLogger

Open the logger, establish a gRPC channel, validate configuration with SBM, and prepare buffers.

open(ParsedOptions, String, Action, Time) - Method in class io.sbk.logger.impl.PrometheusLogger

Open the logger and, if metrics are enabled, start the Prometheus HTTP server.

open(ParsedOptions, String, Action, Time) - Method in class io.sbk.logger.impl.WebLogger

open(ParsedOptions, String, Action, Time) - Method in interface io.sbk.logger.Logger

Open the Logger.

open(String, String, Action, TimeUnit, double[]) - Method in class io.sbk.webconsole.WebConsoleLoggerSupport

Starts or reuses the Local Web Console and registers a benchmark run.

OPEN_OPTION - Static variable in class io.sbk.webconsole.WebConsoleLoggerSupport

Web console browser-open CLI option.

openCSV() - Method in class io.sbk.logger.impl.CSVLogger

Open the CSV and write the header line.

openStorage(ParameterOptions) - Method in interface io.sbk.api.Storage

Open the storage device / client to perform the benchmarking.

OPTION_PAIR_WIDTH - Static variable in class io.sbk.config.Config

Number of tokens in a command-line option/value pair.

P

Package<T> - Class in io.sbk.api

Utility base class for discovering implementation classes in a package.

Package(String) - Constructor for class io.sbk.api.Package

Discovers concrete implementations in a package.

ParameterOptions - Interface in io.sbk.params

Composite interface combining parsed CLI access with typed benchmark parameters.

Parameters - Interface in io.sbk.params

Typed accessors for common SBK benchmark parameters.

params - Variable in class io.sbk.api.Worker

Benchmark parameters shared with this worker.

parseArgs(ParameterOptions) - Method in interface io.sbk.api.Storage

Parse the driver specific command line arguments.

parseArgs(ParsedOptions) - Method in class io.sbk.logger.impl.AbstractRWLogger

parseArgs(ParsedOptions) - Method in class io.sbk.logger.impl.CSVLogger

parseArgs(ParsedOptions) - Method in class io.sbk.logger.impl.GrpcLogger

Parse and validate the required SBM endpoint options.

parseArgs(ParsedOptions) - Method in class io.sbk.logger.impl.PrometheusLogger

parseArgs(ParsedOptions) - Method in class io.sbk.logger.impl.WebLogger

parseArgs(ParsedOptions) - Method in interface io.sbk.logger.Logger

Parse the Metric specific command line arguments.

parseArgs(ParsedOptions) - Method in class io.sbk.webconsole.WebConsoleLoggerSupport

Parses Local Web Console options.

parseArgs(String[]) - Method in class io.sbk.params.impl.SbkInputOptions

Parse the provided arguments into a CommandLine.

parseArgs(String[]) - Method in class io.sbk.params.impl.SbkParameters

Parse SBK core options and compute derived values (e.g., recordsPerSec, totalSecondsToRun).

parseArgs(String[]) - Method in class io.sbk.params.impl.SbkYalParameters

Parse arguments and update YalConfig.yamlFileName to reflect any override from CLI.

parseArgs(String[]) - Method in interface io.sbk.params.ParseInputOptions

Parse the command line arguments.

ParsedOptions - Interface in io.sbk.params

Parsed command-line options accessor.

ParseInputOptions - Interface in io.sbk.params

Contract for parsing command-line arguments into ParsedOptions.

percentiles - Variable in class io.sbk.logger.LoggerConfig

Comma-separated percentile list (e.g., "50, 75, 95, 99, 99.9").

perlChannel - Variable in class io.sbk.api.Worker

Performance channel used to publish measurements.

perlExecutorParallelism - Variable in class io.sbk.config.SbkRuntimeConfig

Parallelism of the PerL executor.

Platform - Enum constant in enum class io.sbk.thread.ThreadType

Platform threads - Traditional OS threads for CPU-intensive workloads.

port - Variable in class io.sbk.logger.MetricsConfig

HTTP port for the metrics endpoint.

port - Variable in class io.sbk.logger.SbmHostConfig

Port of the SBM server.

PORT_OPTION - Static variable in class io.sbk.webconsole.WebConsoleLoggerSupport

Web console port CLI option.

print(double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.AbstractRWLogger

print(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.AbstractRWLogger

print(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.CSVLogger

Print the periodic results to System.out at the end of each interval.

print(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.GrpcLogger

Print the periodic results to System.out at the end of each interval.

print(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.PrometheusLogger

Print the periodic results to System.out at the end of each interval.

print(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.Sl4jLogger

Print the periodic results to System.out at the end of each interval.

print(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.SystemLogger

Print the periodic results to System.out at the end of each interval.

print(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.WebLogger

Print the periodic results to System.out at the end of each interval.

print(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.SbkPrometheusServer

Update Micrometer counters/gauges and delegate latency stats to the base server.

print(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in interface io.sbk.logger.RWPrint

Print the Periodic performance results.

print(long, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.SystemLogger

Print the periodic results to System.out at the end of each interval.

print(long, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.CSVLogger

print(long, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.GrpcLogger

Print periodic results locally and enqueue the corresponding exact latency batch for SBM.

print(long, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.PrometheusLogger

print(long, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.Sl4jLogger

Log the periodic results using SLF4J at info level.

print(long, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.WebLogger

PRINT_OPTION - Static variable in class io.sbk.config.YalConfig

PRINT_OPTION = "PRINT_OPTION";.

PRINT_OPTION_ARG - Static variable in class io.sbk.config.YalConfig

PRINT_OPTION_ARG = ARG_PREFIX + PRINT_OPTION;.

printClasses(String) - Method in class io.sbk.api.Package

Logs the discovered implementation names.

Printer - Class in io.sbk.system

Central SBK application logger.

Printer() - Constructor for class io.sbk.system.Printer

Creates an SBK printer facade.

printHelp() - Method in interface io.sbk.params.ParsedOptions

Print the -help output.

printTotal(double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.AbstractRWLogger

printTotal(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.AbstractRWLogger

printTotal(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.CSVLogger

Print the final accumulated totals to System.out at the end of the run.

printTotal(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.GrpcLogger

Print the final accumulated totals to System.out at the end of the run.

printTotal(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.PrometheusLogger

Print the final accumulated totals to System.out at the end of the run.

printTotal(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.Sl4jLogger

Print the final accumulated totals to System.out at the end of the run.

printTotal(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.SystemLogger

Print the final accumulated totals to System.out at the end of the run.

printTotal(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.WebLogger

Print the final accumulated totals to System.out at the end of the run.

printTotal(int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in interface io.sbk.logger.RWLogger

Print the "Total" roll-up, typically at the end of a benchmark run.

printTotal(long, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.GrpcLogger

Print the final accumulated totals to System.out at the end of the run.

printTotal(long, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.SystemLogger

Print the final accumulated totals to System.out at the end of the run.

printTotal(long, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.CSVLogger

printTotal(long, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.Sl4jLogger

Log the final accumulated totals using SLF4J at info level.

printTotal(long, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.WebLogger

PrometheusLinks - Class in io.sbk.logger.impl

Builds and prints copy-paste URLs for the embedded Prometheus scrape endpoint.

PrometheusLinks.Link - Record Class in io.sbk.logger.impl

A labeled, copy-paste URL for one Prometheus endpoint address.

PrometheusLogger - Class in io.sbk.logger.impl

Class for Recoding/Printing benchmark results on micrometer Composite Meter Registry.

PrometheusLogger() - Constructor for class io.sbk.logger.impl.PrometheusLogger

Creates a Prometheus logger with no server initialized.

ProtoBufByteString - Class in io.sbk.data.impl

Class for processing Byte String data.

ProtoBufByteString() - Constructor for class io.sbk.data.impl.ProtoBufByteString

Creates a protobuf byte-string data generator.

publish(int, int, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.webconsole.WebConsoleLoggerSupport

Publishes one regular reporting-window snapshot without blocking the caller on HTTP I/O.

R

RateController - Interface in io.sbk.api

Interface for Rate or Throughput Controller.

read() - Method in interface io.sbk.api.Reader

Read the data.

Read_OnlyWriting - Enum constant in enum class io.sbk.action.Action

Read_OnlyWriting = 5.

Read_Writing - Enum constant in enum class io.sbk.action.Action

Read_Writing = 4.

readAsync(int) - Method in interface io.sbk.api.AsyncReader

Read the dat asynchronously.

Reader<T> - Interface in io.sbk.api

Reader abstraction used by SBK drivers to provide synchronous read semantics.

Reading - Enum constant in enum class io.sbk.action.Action

Reading = 1.

ReadRequestsLogger - Interface in io.sbk.logger

Read-side request logging hooks used by SBK loggers.

record(long, long, int, int) - Method in interface io.sbk.api.Callback

Accept the benchmarking data.

record(long, long, int, int) - Method in class io.sbk.api.impl.SbkCallbackReader

Deprecated.

Records a completed callback batch and completes the benchmark when its configured duration or record target is reached.

recordBenchmark(long, long, int, int) - Method in class io.sbk.api.AbstractCallbackReader

Keeps record of Benchmark if record gets completed it call complete function.

recordLatency(long, int, int, long) - Method in class io.sbk.logger.impl.GrpcLogger

Record individual latency values into the local LatencyRecorder and stage them for gRPC export.

recordLatency(long, int, int, long) - Method in class io.sbk.logger.impl.SystemLogger

Intentionally ignores the individual latency callback.

recordRead(DataType, int, Time, Status, PerlChannel) - Method in interface io.sbk.api.AsyncReader

Default implementation for Reading data using AsyncReader.readAsync(int) ()} and recording the benchmark statistics.

recordRead(DataType, int, Time, Status, PerlChannel) - Method in interface io.sbk.api.DataRecordsReader

Record the single or multiple reads performance statistics.

recordRead(DataType, int, Time, Status, PerlChannel) - Method in interface io.sbk.api.DataRecordsReader.RecordTime

Method to Read records.

recordRead(DataType, int, Time, Status, PerlChannel) - Method in interface io.sbk.api.Reader

Default implementation for Reading data using Reader.read() and recording the benchmark statistics.

recordRead(DataType, int, Time, Status, PerlChannel, int, ReadRequestsLogger) - Method in interface io.sbk.api.AsyncReader

Default implementation for Reading data using AsyncReader.readAsync(int) ()} and recording the benchmark statistics.

recordRead(DataType, int, Time, Status, PerlChannel, int, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Record the single or multiple reads performance statistics.

recordRead(DataType, int, Time, Status, PerlChannel, int, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader.RecordTimeRequests

Method to Read records.

recordRead(DataType, int, Time, Status, PerlChannel, int, ReadRequestsLogger) - Method in interface io.sbk.api.Reader

Default implementation for Reading data using Reader.read() and recording the benchmark statistics.

recordReadRequests(int, long, long, long) - Method in class io.sbk.logger.impl.AbstractRWLogger

recordReadRequests(int, long, long, long) - Method in interface io.sbk.logger.ReadRequestsLogger

Record one or more read requests attributed to a reader.

recordReadRequests(int, long, long, long) - Method in interface io.sbk.logger.RWLogger

Default method to record every/multiple read event(s).

recordReadTime(DataType, int, Time, Status, PerlChannel) - Method in interface io.sbk.api.AsyncReader

Default implementation for Reading data using Reader.read(), extracting start time from data and recording the benchmark statistics.

recordReadTime(DataType, int, Time, Status, PerlChannel) - Method in interface io.sbk.api.DataRecordsReader

Record the single or multiple reads performance statistics along with the starting time in the data.

recordReadTime(DataType, int, Time, Status, PerlChannel) - Method in interface io.sbk.api.Reader

Default implementation for Reading data using Reader.read(), extracting start time from data and recording the benchmark statistics.

recordReadTime(DataType, int, Time, Status, PerlChannel, int, ReadRequestsLogger) - Method in interface io.sbk.api.AsyncReader

Default implementation for Reading data using Reader.read(), extracting start time from data and recording the benchmark statistics.

recordReadTime(DataType, int, Time, Status, PerlChannel, int, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Record the single or multiple reads performance statistics along with the starting time in the data.

recordReadTime(DataType, int, Time, Status, PerlChannel, int, ReadRequestsLogger) - Method in interface io.sbk.api.Reader

Default implementation for Reading data using Reader.read(), extracting start time from data and recording the benchmark statistics.

recordReadTimeoutEvents(int, long, long) - Method in class io.sbk.logger.impl.AbstractRWLogger

recordReadTimeoutEvents(int, long, long) - Method in interface io.sbk.logger.ReadRequestsLogger

Record read timeout events for a reader.

records - Variable in class io.sbk.api.Status

Number of processed records.

RecordsReader(Worker, long, DataType, Time) - Method in class io.sbk.api.AbstractCallbackReader

Implementation for benchmarking reader by reading given number of records.

RecordsReader(Worker, long, DataType, Time) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading given number of records.

RecordsReader(Worker, long, DataType, Time) - Method in interface io.sbk.api.DataRecordsReader

Default implementation for benchmarking reader by reading given number of records.

RecordsReader(Worker, long, DataType, Time, ReadRequestsLogger) - Method in class io.sbk.api.AbstractCallbackReader

Implementation for benchmarking reader by reading given number of records.

RecordsReader(Worker, long, DataType, Time, ReadRequestsLogger) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading given number of records.

RecordsReader(Worker, long, DataType, Time, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Default implementation for benchmarking reader by reading given number of records.

RecordsReaderRateControl(Worker, long, DataType, Time, RateController) - Method in class io.sbk.api.AbstractCallbackReader

Benchmarking reader by reading given number of records with Rate controlled.

RecordsReaderRateControl(Worker, long, DataType, Time, RateController) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading given number of records with Rate controlled.

RecordsReaderRateControl(Worker, long, DataType, Time, RateController) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading given number of records with Rate controlled.

RecordsReaderRateControl(Worker, long, DataType, Time, RateController, ReadRequestsLogger) - Method in class io.sbk.api.AbstractCallbackReader

Benchmarking reader by reading given number of records with Rate controlled.

RecordsReaderRateControl(Worker, long, DataType, Time, RateController, ReadRequestsLogger) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading given number of records with Rate controlled.

RecordsReaderRateControl(Worker, long, DataType, Time, RateController, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading given number of records with Rate controlled.

RecordsReaderRW(Worker, long, DataType, Time) - Method in class io.sbk.api.AbstractCallbackReader

Default implementation for benchmarking reader by reading given number of records.

RecordsReaderRW(Worker, long, DataType, Time) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading given number of records.

RecordsReaderRW(Worker, long, DataType, Time) - Method in interface io.sbk.api.DataRecordsReader

Default implementation for benchmarking reader by reading given number of records.

RecordsReaderRW(Worker, long, DataType, Time, ReadRequestsLogger) - Method in class io.sbk.api.AbstractCallbackReader

Default implementation for benchmarking reader by reading given number of records.

RecordsReaderRW(Worker, long, DataType, Time, ReadRequestsLogger) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading given number of records.

RecordsReaderRW(Worker, long, DataType, Time, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Default implementation for benchmarking reader by reading given number of records.

RecordsReaderRWRateControl(Worker, long, DataType, Time, RateController) - Method in class io.sbk.api.AbstractCallbackReader

Benchmarking reader by reading given number of records with Rate controlled.

RecordsReaderRWRateControl(Worker, long, DataType, Time, RateController) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading given number of records with Rate controlled.

RecordsReaderRWRateControl(Worker, long, DataType, Time, RateController) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading given number of records with Rate controlled.

RecordsReaderRWRateControl(Worker, long, DataType, Time, RateController, ReadRequestsLogger) - Method in class io.sbk.api.AbstractCallbackReader

Benchmarking reader by reading given number of records with Rate controlled.

RecordsReaderRWRateControl(Worker, long, DataType, Time, RateController, ReadRequestsLogger) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading given number of records with Rate controlled.

RecordsReaderRWRateControl(Worker, long, DataType, Time, RateController, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading given number of records with Rate controlled.

RecordsTimeReader(Worker, long, DataType, Time) - Method in class io.sbk.api.AbstractCallbackReader

Default implementation for benchmarking reader by reading events/records for specific time duration.

RecordsTimeReader(Worker, long, DataType, Time) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading events/records for specific time duration.

RecordsTimeReader(Worker, long, DataType, Time) - Method in interface io.sbk.api.DataRecordsReader

Default implementation for benchmarking reader by reading events/records for specific time duration.

RecordsTimeReader(Worker, long, DataType, Time, ReadRequestsLogger) - Method in class io.sbk.api.AbstractCallbackReader

Default implementation for benchmarking reader by reading events/records for specific time duration.

RecordsTimeReader(Worker, long, DataType, Time, ReadRequestsLogger) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading events/records for specific time duration.

RecordsTimeReader(Worker, long, DataType, Time, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Default implementation for benchmarking reader by reading events/records for specific time duration.

RecordsTimeReaderRateControl(Worker, long, DataType, Time, RateController) - Method in class io.sbk.api.AbstractCallbackReader

Benchmarking reader by reading events/records for specific time duration with Rate controlled.

RecordsTimeReaderRateControl(Worker, long, DataType, Time, RateController) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading events/records for specific time duration with Rate controlled.

RecordsTimeReaderRateControl(Worker, long, DataType, Time, RateController) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading events/records for specific time duration with Rate controlled.

RecordsTimeReaderRateControl(Worker, long, DataType, Time, RateController, ReadRequestsLogger) - Method in class io.sbk.api.AbstractCallbackReader

Benchmarking reader by reading events/records for specific time duration with Rate controlled.

RecordsTimeReaderRateControl(Worker, long, DataType, Time, RateController, ReadRequestsLogger) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading events/records for specific time duration with Rate controlled.

RecordsTimeReaderRateControl(Worker, long, DataType, Time, RateController, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading events/records for specific time duration with Rate controlled.

RecordsTimeReaderRW(Worker, long, DataType, Time) - Method in class io.sbk.api.AbstractCallbackReader

Default implementation for benchmarking reader by reading events/records for specific time duration.

RecordsTimeReaderRW(Worker, long, DataType, Time) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading events/records for specific time duration.

RecordsTimeReaderRW(Worker, long, DataType, Time) - Method in interface io.sbk.api.DataRecordsReader

Default implementation for benchmarking reader by reading events/records for specific time duration.

RecordsTimeReaderRW(Worker, long, DataType, Time, ReadRequestsLogger) - Method in class io.sbk.api.AbstractCallbackReader

Default implementation for benchmarking reader by reading events/records for specific time duration.

RecordsTimeReaderRW(Worker, long, DataType, Time, ReadRequestsLogger) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading events/records for specific time duration.

RecordsTimeReaderRW(Worker, long, DataType, Time, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Default implementation for benchmarking reader by reading events/records for specific time duration.

RecordsTimeReaderRWRateControl(Worker, long, DataType, Time, RateController) - Method in class io.sbk.api.AbstractCallbackReader

Benchmarking reader by reading events/records for specific time duration with Rate controlled.

RecordsTimeReaderRWRateControl(Worker, long, DataType, Time, RateController) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading events/records for specific time duration with Rate controlled.

RecordsTimeReaderRWRateControl(Worker, long, DataType, Time, RateController) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading events/records for specific time duration with Rate controlled.

RecordsTimeReaderRWRateControl(Worker, long, DataType, Time, RateController, ReadRequestsLogger) - Method in class io.sbk.api.AbstractCallbackReader

Benchmarking reader by reading events/records for specific time duration with Rate controlled.

RecordsTimeReaderRWRateControl(Worker, long, DataType, Time, RateController, ReadRequestsLogger) - Method in interface io.sbk.api.DataReader

Benchmarking reader by reading events/records for specific time duration with Rate controlled.

RecordsTimeReaderRWRateControl(Worker, long, DataType, Time, RateController, ReadRequestsLogger) - Method in interface io.sbk.api.DataRecordsReader

Benchmarking reader by reading events/records for specific time duration with Rate controlled.

RecordsWriter(Worker, long, DataType, T, int, Time) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writer benchmarking by writing given number of records.

RecordsWriter(Worker, long, DataType, T, int, Time) - Method in interface io.sbk.api.DataWriter

writer benchmarking by writing given number of records.

RecordsWriter(Worker, long, DataType, T, int, Time, WriteRequestsLogger) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writer benchmarking by writing given number of records.

RecordsWriter(Worker, long, DataType, T, int, Time, WriteRequestsLogger) - Method in interface io.sbk.api.DataWriter

writer benchmarking by writing given number of records.

RecordsWriterRO(Worker, long, DataType, T, int, Time, RateController) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writing given number of records.

RecordsWriterRO(Worker, long, DataType, T, int, Time, RateController) - Method in interface io.sbk.api.DataWriter

Write given number of records.

RecordsWriterRO(Worker, long, DataType, T, int, Time, RateController, WriteRequestsLogger) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writing given number of records.

RecordsWriterRO(Worker, long, DataType, T, int, Time, RateController, WriteRequestsLogger) - Method in interface io.sbk.api.DataWriter

Write given number of records.

RecordsWriterRW(Worker, long, DataType, T, int, Time, RateController) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writing given number of records.

RecordsWriterRW(Worker, long, DataType, T, int, Time, RateController) - Method in interface io.sbk.api.DataWriter

Write given number of records.

RecordsWriterRW(Worker, long, DataType, T, int, Time, RateController, WriteRequestsLogger) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writing given number of records.

RecordsWriterRW(Worker, long, DataType, T, int, Time, RateController, WriteRequestsLogger) - Method in interface io.sbk.api.DataWriter

Write given number of records.

RecordsWriterSync(Worker, long, DataType, T, int, Time, RateController) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writer benchmarking by writing given number of records.

RecordsWriterSync(Worker, long, DataType, T, int, Time, RateController) - Method in interface io.sbk.api.DataWriter

Writer benchmarking by writing given number of records and data should synced is invoked after writing given set of records.

RecordsWriterSync(Worker, long, DataType, T, int, Time, RateController, WriteRequestsLogger) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writer benchmarking by writing given number of records.

RecordsWriterSync(Worker, long, DataType, T, int, Time, RateController, WriteRequestsLogger) - Method in interface io.sbk.api.DataWriter

Writer benchmarking by writing given number of records and data should synced is invoked after writing given set of records.

RecordsWriterTime(Worker, long, DataType, T, int, Time) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writer benchmarking by continuously writing data records for specific time duration.

RecordsWriterTime(Worker, long, DataType, T, int, Time) - Method in interface io.sbk.api.DataWriter

Writer benchmarking by continuously writing data records for specific time duration.

RecordsWriterTime(Worker, long, DataType, T, int, Time, WriteRequestsLogger) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writer benchmarking by continuously writing data records for specific time duration.

RecordsWriterTime(Worker, long, DataType, T, int, Time, WriteRequestsLogger) - Method in interface io.sbk.api.DataWriter

Writer benchmarking by continuously writing data records for specific time duration.

RecordsWriterTimeRO(Worker, long, DataType, T, int, Time, RateController) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writing data records for specific time duration.

RecordsWriterTimeRO(Worker, long, DataType, T, int, Time, RateController) - Method in interface io.sbk.api.DataWriter

Writing data records for specific time duration.

RecordsWriterTimeRO(Worker, long, DataType, T, int, Time, RateController, WriteRequestsLogger) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writing data records for specific time duration.

RecordsWriterTimeRO(Worker, long, DataType, T, int, Time, RateController, WriteRequestsLogger) - Method in interface io.sbk.api.DataWriter

Writing data records for specific time duration.

RecordsWriterTimeRW(Worker, long, DataType, T, int, Time, RateController) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writing data records for specific time duration.

RecordsWriterTimeRW(Worker, long, DataType, T, int, Time, RateController) - Method in interface io.sbk.api.DataWriter

Writing data records for specific time duration.

RecordsWriterTimeRW(Worker, long, DataType, T, int, Time, RateController, WriteRequestsLogger) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writing data records for specific time duration.

RecordsWriterTimeRW(Worker, long, DataType, T, int, Time, RateController, WriteRequestsLogger) - Method in interface io.sbk.api.DataWriter

Writing data records for specific time duration.

RecordsWriterTimeSync(Worker, long, DataType, T, int, Time, RateController) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writer benchmarking by continuously writing data records for specific time duration.

RecordsWriterTimeSync(Worker, long, DataType, T, int, Time, RateController) - Method in interface io.sbk.api.DataWriter

writer benchmarking by continuously writing data records for specific time duration.

RecordsWriterTimeSync(Worker, long, DataType, T, int, Time, RateController, WriteRequestsLogger) - Method in interface io.sbk.api.DataRecordsWriter

Default implementation for writer benchmarking by continuously writing data records for specific time duration.

RecordsWriterTimeSync(Worker, long, DataType, T, int, Time, RateController, WriteRequestsLogger) - Method in interface io.sbk.api.DataWriter

writer benchmarking by continuously writing data records for specific time duration.

recordWrite(DataType, T, int, Time, Status, PerlChannel) - Method in interface io.sbk.api.DataRecordsWriter

Write the data and record the benchmark statistics.

recordWrite(DataType, T, int, Time, Status, PerlChannel) - Method in interface io.sbk.api.Writer

Default implementation for writing data using Writer.write(DataType, Object, int, Time, Status) and recording the benchmark statistics.

recordWrite(DataType, T, int, Time, Status, PerlChannel, int, WriteRequestsLogger) - Method in interface io.sbk.api.DataRecordsWriter

Write the data and record the benchmark statistics.

recordWrite(DataType, T, int, Time, Status, PerlChannel, int, WriteRequestsLogger) - Method in interface io.sbk.api.Writer

Default implementation for writing data using Writer.write(DataType, Object, int, Time, Status) and recording the benchmark statistics.

recordWriteRequests(int, long, long, long) - Method in class io.sbk.logger.impl.AbstractRWLogger

recordWriteRequests(int, long, long, long) - Method in interface io.sbk.logger.RWLogger

Default method to record every/multiple write event(s).

recordWriteRequests(int, long, long, long) - Method in interface io.sbk.logger.WriteRequestsLogger

Record one or more write requests attributed to a writer.

recordWriteTimeoutEvents(int, long, long) - Method in class io.sbk.logger.impl.AbstractRWLogger

recordWriteTimeoutEvents(int, long, long) - Method in interface io.sbk.logger.WriteRequestsLogger

Record write timeout events for a writer.

redactOptionValues(String[], String[]) - Static method in class io.sbk.utils.SbkUtils

Return a copy of command-line arguments with values belonging to sensitive options replaced by a fixed mask.

redactSensitiveOptionValues(String[]) - Static method in class io.sbk.utils.SbkUtils

Return a copy of SBK arguments with values for commonly used credential options replaced by a fixed mask.

register(String, Runnable) - Static method in class io.sbk.utils.ApplicationShutdownHook

Registers a shutdown hook for an application benchmark.

REGULAR_PRINT - Static variable in class io.sbk.logger.impl.CSVLogger

REGULAR_PRINT = "Regular".

remove(Thread) - Static method in class io.sbk.utils.ApplicationShutdownHook

Removes a previously registered hook after normal application shutdown.

removeOptionArgs(String[], String[]) - Static method in class io.sbk.utils.SbkUtils

Removes each named option once while retaining other arguments.

removeOptionArgsAndValues(String[], String[]) - Static method in class io.sbk.utils.SbkUtils

Removes each named option and its following value once.

reportFailure(Throwable) - Method in class io.sbk.logger.impl.GrpcLogger

Sends a terminal SBK failure to SBM before closing the client channel.

reportFailure(Throwable) - Method in interface io.sbk.logger.Logger

Reports a terminal benchmark failure before the logger transport is closed.

reportingSeconds - Variable in class io.sbk.logger.LoggerConfig

Reporting interval in seconds for periodic prints.

run(long, long) - Method in class io.sbk.api.impl.SbkReader

run(long, long) - Method in class io.sbk.api.impl.SbkWriter

run(Worker, long, long, DataType, Time, Callback) - Method in class io.sbk.api.AbstractCallbackReader

Default Implementation run the Benchmark.

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

Run the Performance Benchmarking .

RWLogger - Interface in io.sbk.logger

Read/Write logger interface that combines request logging and printing hooks.

RWLoggerPackage - Class in io.sbk.api

Package helper for discovering RWLogger implementations on the classpath.

RWLoggerPackage(String) - Constructor for class io.sbk.api.RWLoggerPackage

Creates a scanner for the supplied logger package.

rwMetricPrefix - Variable in class io.sbk.logger.impl.SbkPrometheusServer

Metric name prefix derived from the header (upper-cased and '_' separated).

RWPrint - Interface in io.sbk.logger

Prints periodic read/write benchmark results.

S

Sbk - Class in io.sbk.api.impl

Central SBK bootstrap and factory helper.

Sbk() - Constructor for class io.sbk.api.impl.Sbk

Creates an SBK bootstrap helper.

SBK_APP_HOME - Static variable in class io.sbk.config.Config

SBK_APP_HOME = "sbk.appHome";.

SBK_APP_NAME - Static variable in class io.sbk.config.Config

SBK_APP_NAME = "sbk.applicationName";.

SBK_CLASS_NAME - Static variable in class io.sbk.config.Config

SBK_CLASS_NAME = "sbk.className";.

SBK_FOOTER - Static variable in class io.sbk.config.Config

SBK_FOOTER = "\nPlease report issues at " + SBK_WEBSITE_NAME;.

SBK_LOGGER_PACKAGE_NAME - Static variable in class io.sbk.config.Config

SBK_LOGGER_PACKAGE_NAME = "io.sbk.logger";.

SBK_STORAGE_PACKAGE_NAME - Static variable in class io.sbk.config.Config

SBK_STORAGE_PACKAGE_NAME = "io.sbk.driver";.

SBK_WEBSITE_NAME - Static variable in class io.sbk.config.Config

SBK_WEBSITE_NAME = "https://github.com/kmgowda/SBK";.

SbkBenchmark - Class in io.sbk.api.impl

Class for performing the benchmark.

SbkBenchmark(ParameterOptions, Storage, DataType, RWLogger, Time) - Constructor for class io.sbk.api.impl.SbkBenchmark

Create SBK Benchmark.

SbkCallbackReader - Class in io.sbk.api.impl

Deprecated.

This interface is replaced by Abstract class AbstractCallbackReader and SbkReader.

SbkCallbackReader(int, ParameterOptions, PerlChannel, int, DataType, Time) - Constructor for class io.sbk.api.impl.SbkCallbackReader

Deprecated.

Creates the deprecated callback-based benchmark reader.

SbkConfig - Class in io.sbk.config

SBK command defaults and the separately loaded PerL configuration.

SbkConfig() - Constructor for class io.sbk.config.SbkConfig

Creates an empty configuration for properties binding.

SbkDriversParameters - Class in io.sbk.params.impl

Parameters implementation that exposes storage driver and logger selection options.

SbkDriversParameters(String, String[], String[]) - Constructor for class io.sbk.params.impl.SbkDriversParameters

Convenience constructor using the default description.

SbkDriversParameters(String, String, String[], String[]) - Constructor for class io.sbk.params.impl.SbkDriversParameters

Create parameters with custom help description and available drivers/loggers.

SbkInputOptions - Class in io.sbk.params.impl

Default implementation of ParseInputOptions based on Apache Commons CLI.

SbkInputOptions(String, String) - Constructor for class io.sbk.params.impl.SbkInputOptions

Creates an SBK command-line option parser.

SbkMain - Class in io.sbk.main

Main class of SBK.

SbkMain() - Constructor for class io.sbk.main.SbkMain

Creates an SBK command-line entry point.

SbkParameters - Class in io.sbk.params.impl

Parses and exposes common SBK benchmark parameters.

SbkParameters(String) - Constructor for class io.sbk.params.impl.SbkParameters

Construct parameters using the default description.

SbkParameters(String, String) - Constructor for class io.sbk.params.impl.SbkParameters

Construct parameters with the given benchmark name and description.

SbkPrometheusServer - Class in io.sbk.logger.impl

Prometheus metrics server adapter for SBK read/write benchmarks.

SbkPrometheusServer(String, String, String, double[], Time, MetricsConfig) - Constructor for class io.sbk.logger.impl.SbkPrometheusServer

Construct the SBK Prometheus metrics server.

SbkPrometheusServer(String, String, String, double[], Time, MetricsConfig, String) - Constructor for class io.sbk.logger.impl.SbkPrometheusServer

Construct an SBK-compatible Prometheus server for a specific exporting component.

SbkRateController - Class in io.sbk.api.impl

Simple rate controller used by SBK to pace operations to a target records-per-second value.

SbkRateController() - Constructor for class io.sbk.api.impl.SbkRateController

Creates an inactive rate controller.

SbkReader - Class in io.sbk.api.impl

Reader Benchmarking Implementation.

SbkReader(int, ParameterOptions, PerlChannel, DataType, Time, DataReader, CountReaders, ReadRequestsLogger, ExecutorService) - Constructor for class io.sbk.api.impl.SbkReader

Creates a benchmark reader worker.

SbkRuntimeConfig - Class in io.sbk.config

Lifecycle and executor settings shared by the SBK benchmark runtime.

SbkRuntimeConfig() - Constructor for class io.sbk.config.SbkRuntimeConfig

Creates an empty configuration for properties binding.

SbkString - Class in io.sbk.data.impl

Class for processing byte[] data.

SbkString() - Constructor for class io.sbk.data.impl.SbkString

Creates a string data generator.

SbkUtils - Class in io.sbk.utils

Utility methods for inspecting, filtering, and merging SBK arguments.

SbkUtils() - Constructor for class io.sbk.utils.SbkUtils

Creates an SBK argument utility.

SbkWriter - Class in io.sbk.api.impl

Writer Benchmarking Implementation.

SbkWriter(int, ParameterOptions, PerlChannel, DataType, Time, DataWriter, CountWriters, WriteRequestsLogger, ExecutorService) - Constructor for class io.sbk.api.impl.SbkWriter

Creates a benchmark writer worker.

SbkYalParameters - Class in io.sbk.params.impl

Parses YAML-launcher command-line parameters.

SbkYalParameters(String, String, YalConfig) - Constructor for class io.sbk.params.impl.SbkYalParameters

Create a YAML parameters handler.

SbmHostConfig - Class in io.sbk.logger

Configuration for the SBK Benchmark Manager (SBM) gRPC endpoint.

SbmHostConfig() - Constructor for class io.sbk.logger.SbmHostConfig

Creates an empty SBM host configuration for property binding.

Sbp - Class in io.sbp.api

Loads the Storage Benchmark Protocol version used by SBK and SBM.

Sbp() - Constructor for class io.sbp.api.Sbp

Creates an SBP version-resource accessor.

SbpFailureLimits - Class in io.sbp.config

Shared SBP failure-diagnostic wire limits used by clients and servers.

SbpVersion - Class in io.sbp.config

Storage Benchmark Protocol major and minor version.

SbpVersion() - Constructor for class io.sbp.config.SbpVersion

Creates an invalid version that can be populated by property binding.

setExceptionHandler(ExceptionHandler) - Method in class io.sbk.logger.impl.GrpcLogger

Sets the benchmark exception handler notified when the gRPC transport fails.

setExceptionHandler(ExceptionHandler) - Method in interface io.sbk.logger.Logger

Default implementation for setting exception handler.

setMaxReaders(int) - Method in class io.sbk.logger.impl.AbstractRWLogger

setMaxReaders(int) - Method in interface io.sbk.logger.SetRW

Update the max number of readers seen so far.

setMaxReadersIds(int) - Method in class io.sbk.logger.impl.AbstractRWLogger

Sets the number of reader request-counter slots.

setMaxWriters(int) - Method in class io.sbk.logger.impl.AbstractRWLogger

setMaxWriters(int) - Method in interface io.sbk.logger.SetRW

Update the max number of writers seen so far.

setMaxWritersIds(int) - Method in class io.sbk.logger.impl.AbstractRWLogger

Sets the number of writer request-counter slots.

setReaders(int) - Method in class io.sbk.logger.impl.AbstractRWLogger

setReaders(int) - Method in interface io.sbk.logger.SetRW

Set current number of active readers.

SetRW - Interface in io.sbk.logger

Interface SetRW.

setTime(byte[], long) - Method in class io.sbk.data.impl.ByteArray

Set the time for data.

setTime(ByteString, long) - Method in class io.sbk.data.impl.ProtoBufByteString

Set the time for data.

setTime(String, long) - Method in class io.sbk.data.impl.SbkString

Set the time for data.

setTime(ByteBuffer, long) - Method in class io.sbk.data.impl.NioByteBuffer

Set the time for data.

setTime(T, long) - Method in interface io.sbk.data.DataType

Set the time for data.

setWriters(int) - Method in class io.sbk.logger.impl.AbstractRWLogger

setWriters(int) - Method in interface io.sbk.logger.SetRW

Set current number of active writers.

shutdownHookTimeoutSeconds - Variable in class io.sbk.config.SbkRuntimeConfig

JVM shutdown-hook cleanup timeout in seconds.

Sl4jLogger - Class in io.sbk.logger.impl

Logger implementation that prints periodic and total benchmark results using SLF4J.

Sl4jLogger() - Constructor for class io.sbk.logger.impl.Sl4jLogger

Creates an SLF4J-backed benchmark logger.

SNAPSHOT_MINUTES_OPTION - Static variable in class io.sbk.webconsole.WebConsoleLoggerSupport

Web console history duration CLI option.

start() - Method in interface io.sbk.api.Benchmark

Start the Benchmark.

start() - Method in class io.sbk.api.impl.SbkBenchmark

Start SBK Benchmark.

start() - Method in class io.sbk.api.impl.SbkCallbackReader

Deprecated.

start(int) - Method in class io.sbk.api.impl.SbkRateController

Start the Rate Controller.

start(int) - Method in interface io.sbk.api.RateController

Start the Rate Controller.

start(Callback) - Method in class io.sbk.api.AbstractCallbackReader

set the Callback and start the CallBack Reader.

startTime - Variable in class io.sbk.api.Status

Operation start timestamp.

Status - Class in io.sbk.api

Holder for per-operation read/write status used by the SBK harness.

Status() - Constructor for class io.sbk.api.Status

Creates an empty operation status.

stop() - Method in class io.sbk.api.AbstractCallbackReader

Stop the CallBack Reader.

stop() - Method in interface io.sbk.api.Benchmark

stop/shutdown the Benchmark.

stop() - Method in class io.sbk.api.impl.SbkBenchmark

Stop/shutdown SBK Benchmark.

stop() - Method in class io.sbk.api.impl.SbkCallbackReader

Deprecated.

Storage<T> - Interface in io.sbk.api

Storage driver interface used by the SBK harness.

StoragePackage - Class in io.sbk.api

Concrete Package implementation for discovering Storage implementations on the classpath.

StoragePackage(String) - Constructor for class io.sbk.api.StoragePackage

Creates a scanner for the supplied storage package.

streamCloseTimeoutSeconds - Variable in class io.sbk.logger.SbmHostConfig

Stream drain and acknowledgement timeout in seconds.

SUCCESS - Static variable in class io.sbk.config.ExitCode

Successful execution.

sync() - Method in interface io.sbk.api.DataRecordsWriter

Flush / Sync the data.

sync() - Method in interface io.sbk.api.Writer

Flush / Sync the data.

SystemLogger - Class in io.sbk.logger.impl

Logger implementation that prints periodic and total benchmark results to System.out.

SystemLogger() - Constructor for class io.sbk.logger.impl.SystemLogger

Creates a system-output benchmark logger.

T

ThreadType - Enum Class in io.sbk.thread

Thread types available in Java 25 for SBK benchmarking.

ThreadTypeParameter - Interface in io.sbk.params

Interface for parameters that provide thread type configuration.

TIME_HEADER_BYTES - Static variable in interface io.sbk.data.DataType

TIME_HEADER_BYTES = 8;.

TIMEOUT_OPTION - Static variable in class io.sbk.webconsole.WebConsoleLoggerSupport

Web console idle-timeout CLI option.

timeUnit - Variable in class io.sbk.logger.LoggerConfig

Time unit used to interpret configured minimum and maximum latency.

toString() - Method in record class io.sbk.logger.impl.PrometheusLinks.Link

Returns a string representation of this record class.

TOTAL_PRINT - Static variable in class io.sbk.logger.impl.CSVLogger

TOTAL_PRINT = "Total".

TRUNCATION_MARKER - Static variable in class io.sbp.config.SbpFailureLimits

Marker inserted between retained diagnostic prefix and suffix.

U

uri() - Method in record class io.sbk.logger.impl.PrometheusLinks.Link

Returns the value of the uri record component.

V

valueOf(String) - Static method in enum class io.sbk.action.Action

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.sbk.thread.ThreadType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.sbk.action.Action

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.sbk.thread.ThreadType

Returns an array containing the constants of this enum class, in the order they are declared.

VERSION_OPTION - Static variable in class io.sbk.config.Config

VERSION_OPTION = "version";.

VERSION_OPTION_ARG - Static variable in class io.sbk.config.Config

VERSION_OPTION_ARG = ARG_PREFIX + VERSION_OPTION;.

VERSION_OPTION_ARG_SHORT - Static variable in class io.sbk.config.Config

VERSION_OPTION_ARG_SHORT = ARG_PREFIX + VERSION_OPTION_SHORT;.

VERSION_OPTION_SHORT - Static variable in class io.sbk.config.Config

VERSION_OPTION_SHORT = "v";.

Virtual - Enum constant in enum class io.sbk.thread.ThreadType

Virtual threads - Lightweight threads for I/O-bound operations.

W

waitToComplete() - Method in class io.sbk.api.AbstractCallbackReader

Default Implementation to wait for the readers to complete.

WebConsoleLoggerSupport - Class in io.sbk.webconsole

Shared Local Web Console configuration, lifecycle, and snapshot construction for SBK, SBM, and GEM loggers.

WebConsoleLoggerSupport() - Constructor for class io.sbk.webconsole.WebConsoleLoggerSupport

Creates Local Web Console support with configuration loaded when arguments are added.

WebLogger - Class in io.sbk.logger.impl

SBK logger that preserves console/CSV reporting and publishes live summaries to the Local Web Console.

WebLogger() - Constructor for class io.sbk.logger.impl.WebLogger

Creates a web logger with no Local Web Console process started.

Worker - Class in io.sbk.api

Abstract class for Writers and Readers.

Worker(int, Parameters, PerlChannel) - Constructor for class io.sbk.api.Worker

Creates a benchmark worker.

workerExecutorReserve - Variable in class io.sbk.config.SbkRuntimeConfig

Executor threads reserved for lifecycle and measurement tasks.

workerTerminationSeconds - Variable in class io.sbk.config.SbkRuntimeConfig

Worker executor termination wait in seconds.

write(DataType, T, int, Time, Status) - Method in interface io.sbk.api.DataRecordsWriter

Write the Data and attach the start time to data.

write(DataType, T, int, Time, Status) - Method in interface io.sbk.api.Writer

Default implementation for writing data using Writer.writeAsync(Object))} with start time.

write(DataType, T, int, Time, Status, int, WriteRequestsLogger) - Method in interface io.sbk.api.DataRecordsWriter

Write the Data and attach the start time to data.

write(DataType, T, int, Time, Status, int, WriteRequestsLogger) - Method in interface io.sbk.api.Writer

Default implementation for writing data using Writer.writeAsync(Object))} with start time.

Write_OnlyReading - Enum constant in enum class io.sbk.action.Action

Write_OnlyReading = 3.

Write_Reading - Enum constant in enum class io.sbk.action.Action

Write_Reading = 2.

writeAsync(T) - Method in interface io.sbk.api.Writer

Asynchronously Writes the data .

Writer<T> - Interface in io.sbk.api

Writer interface used by SBK drivers to provide asynchronous write semantics.

WriteRequestsLogger - Interface in io.sbk.logger

Write-side request logging hooks used by SBK loggers.

writeSetTime(DataType, T, int, Time, Status) - Method in interface io.sbk.api.DataRecordsWriter

Write the Data and attach the start time to data.

writeSetTime(DataType, T, int, Time, Status) - Method in interface io.sbk.api.Writer

Default implementation for writing data using Writer.writeAsync(Object) with start time If you are intend to NOT use the CompletableFuture returned by Writer.writeAsync(Object) )} then you can override this method.

writeSetTime(DataType, T, int, Time, Status, int, WriteRequestsLogger) - Method in interface io.sbk.api.DataRecordsWriter

Write the Data and attach the start time to data.

writeSetTime(DataType, T, int, Time, Status, int, WriteRequestsLogger) - Method in interface io.sbk.api.Writer

Default implementation for writing data using Writer.writeAsync(Object) with start time If you are intend to NOT use the CompletableFuture returned by Writer.writeAsync(Object) )} then you can override this method.

writeToCSV(String, String, long, long, long, int, int, int, int, long, double, long, double, long, double, long, double, long, long, long, long, long, long, long, double, long, double, double, long, long, double, double, double, long, long, long, long, long, long, long, long[], long[]) - Method in class io.sbk.logger.impl.CSVLogger

Write a single record (row) to the CSV file.

Writing - Enum constant in enum class io.sbk.action.Action

Writing = 0.

Y

YalConfig - Class in io.sbk.config

Class YalConfig.

YalConfig() - Constructor for class io.sbk.config.YalConfig

Creates an empty YAML launcher configuration for property binding.

YalParameters - Interface in io.sbk.params

Parameters contract for YAML-based configuration (YAL) support.

yamlFileName - Variable in class io.sbk.config.YalConfig

String yamlFileName.

YmlMap - Class in io.sbk.params

Helper base class for mapping YAML files to CLI argument arrays.

YmlMap(Map) - Constructor for class io.sbk.params.YmlMap

Create a YmlMap with the provided arguments map.

A B C D E F G H I L M N O P R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form