com.netflix.ndbench.api.plugin

Interface NdBenchAbstractClient<W>

Type Parameters:

W - - the type of the result returned by writeSingle(java.lang.String)

All Known Subinterfaces:

NdBenchClient

All Known Implementing Classes:

NdBenchBaseClient

public interface NdBenchAbstractClient<W>

Defines default methods that provide a hook point for Auto-tuning, more information for which may be found here.

This interface provides backward compatability with legacy client plug-ins (which do not support auto-tuning) since the interface NdBenchClient concretizes the type parameter 'W' to the type that heretofore has been returned by all clients implementing the writeSingle method (namely: String.)

Method Summary

Modifier and Type	Method and Description
default double	autoTuneReadRateLimit(double currentRateLimit, W event, NdBenchMonitor runStats) See documentation for autoTuneWriteRateLimit(java.lang.Double, W, com.netflix.ndbench.api.plugin.NdBenchMonitor)
default java.lang.Double	autoTuneWriteRateLimit(java.lang.Double currentRateLimit, W event, NdBenchMonitor runStats) Implementations of the autoTune[Write/Read]RateLimit methods will interpret the information provided by 'event' and 'runStats', and 'currentRateLimit' in order to determine whether or not it is appropriate to auto-tune read / write rate limits for the currently running benchmark.
java.lang.String	getConnectionInfo() Get connection info
void	init(DataGenerator dataGenerator) Initialize the client
java.lang.String	readSingle(java.lang.String key) Perform a single read operation
java.lang.String	runWorkFlow() Run workflow for functional testing
void	shutdown() shutdown the client
W	writeSingle(java.lang.String key) Perform a single write operation

Method Detail

init

void init(DataGenerator dataGenerator)
   throws java.lang.Exception

Initialize the client

Throws:

java.lang.Exception

readSingle

java.lang.String readSingle(java.lang.String key)
                     throws java.lang.Exception

Perform a single read operation

Returns:

Throws:

java.lang.Exception

writeSingle

W writeSingle(java.lang.String key)
       throws java.lang.Exception

Perform a single write operation

Returns:

Throws:

java.lang.Exception

shutdown

void shutdown()
       throws java.lang.Exception

shutdown the client

Throws:

java.lang.Exception

getConnectionInfo

java.lang.String getConnectionInfo()
                            throws java.lang.Exception

Get connection info

Throws:

java.lang.Exception

runWorkFlow

java.lang.String runWorkFlow()
                      throws java.lang.Exception

Run workflow for functional testing

Throws:

java.lang.Exception

autoTuneWriteRateLimit

default java.lang.Double autoTuneWriteRateLimit(java.lang.Double currentRateLimit,
                                                W event,
                                                NdBenchMonitor runStats)

Implementations of the autoTune[Write/Read]RateLimit methods will interpret the information provided by 'event' and 'runStats', and 'currentRateLimit' in order to determine whether or not it is appropriate to auto-tune read / write rate limits for the currently running benchmark.

This method will be called by the benchmark driver after every write operation (this applies to the initial implementation -- subsequent releases may also allow tuning based on responses to read operations).

Note that if there are multiple read or write workers it is possible that an attempt by one thread to auto-tune the rate limit to a particular level might be overwritten by the rate limit value set by another thread. But such overwrites should not affect the eventual trend of the rate limit either downward or upward.

Parameters:

currentRateLimit - - the write rate limit currently in effect.

event - - conveys information related to the most recently performed read or write operation which this method will use to decide whether or not it is appropriate to auto-tune write / read rate limits for the currently running benchmark. An event will typically capture details of errors occurring in the context of an attempt to perform either a read or write operation.

runStats - - statistics such as average write/read latency for current benchmark run

Returns:

- the new suggested rate limit -- ignored by driver if less-than-or-equal-to 0.

autoTuneReadRateLimit

default double autoTuneReadRateLimit(double currentRateLimit,
                                     W event,
                                     NdBenchMonitor runStats)

See documentation for autoTuneWriteRateLimit(java.lang.Double, W, com.netflix.ndbench.api.plugin.NdBenchMonitor)