Class SimFramePlanner<C,P extends Record>

java.lang.Object

io.nosqlbench.nb.api.components.core.NBBaseComponentMetrics

io.nosqlbench.nb.api.components.core.NBBaseComponent

io.nosqlbench.scenarios.simframe.planning.SimFramePlanner<C,P>

Type Parameters:

C - The configuration type for the planner

All Implemented Interfaces:

NBComponent, NBComponentAdvisors, NBComponentEvents, NBComponentMetrics, NBComponentProps, NBComponentServices, NBComponentTimeline, NBProviderSearch, NBTokenWords, NBLabeledElement, AutoCloseable

Direct Known Subclasses:

FindmaxPlanner, RatchetPlanner, RCurvePlanner

public abstract class SimFramePlanner<C,P extends Record>
extends NBBaseComponent

A frame planner is what decides what next set of parameters to try based on a history of simulation frames, and whether to proceed with another sim frame.

Nested Class Summary

Nested classes/interfaces inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

NBLabeledElement.BasicLabeledElement

Field Summary

Fields

Modifier and Type	Field	Description
protected final C	config
protected final SimFrameJournal<P>	journal
protected final org.apache.logging.log4j.Logger	logger

Fields inherited from class io.nosqlbench.nb.api.components.core.NBBaseComponent

bufferOrphanedMetrics, closed_ns, error, errored_ns, labels, metricsBuffer, parent, started_epoch_ms, started_ns, state, teardown_ns

Fields inherited from interface io.nosqlbench.nb.api.components.core.NBComponent

EMPTY_COMPONENT

Fields inherited from interface io.nosqlbench.nb.api.components.core.NBComponentProps

HDRDIGITS, SUMMARY

Fields inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

EMPTY

Constructor Summary

Constructors

Constructor	Description
SimFramePlanner(NBBaseComponent parent, NBCommandParams analyzerParams)

Method Summary

Modifier and Type	Method	Description
P	analyze(Activity flywheel, SimFrameCapture capture, PrintWriter stdout, PrintWriter stderr, ContainerActivitiesController controller)
abstract void	applyParams(P params, Activity activity)
abstract C	getConfig(NBCommandParams params)
abstract P	initialStep()
SimFrameJournal<P>	initJournal()
abstract P	nextStep(JournalView<P> journal)	Using a stateful history of all control parameters and all results, decide if there is additional search space and return a set of parameters for the next workload simulation frame.

Methods inherited from class io.nosqlbench.nb.api.components.core.NBBaseComponent

addAdvisor, addMetricsCloseable, attachChild, beforeDetach, close, create, detachChild, find, findParentService, getAdvisors, getChildren, getComponentOnlyLabels, getComponentProp, getComponentState, getLabels, getNanosSinceStart, getParent, getTokens, nanosof_close, nanosof_error, nanosof_start, nanosof_teardown, onError, onEvent, reportExecutionMetric, setComponentProp, started_epoch_ms, teardown, toString

Methods inherited from class io.nosqlbench.nb.api.components.core.NBBaseComponentMetrics

addComponentMetric, addListener, findComponentMetrics, findComponentMetrics, getComponentMetric, getComponentMetrics, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.nosqlbench.nb.api.components.core.NBComponentAdvisors

getAdvisorResults

Methods inherited from interface io.nosqlbench.nb.api.components.core.NBComponentMetrics

addComponentMetric, findComponentMetrics, findComponentMetrics, findOneComponentMetric, findOneComponentMetric, getComponentMetric, getComponentMetrics

Methods inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

description

Field Details

logger

protected final org.apache.logging.log4j.Logger logger

config

protected final C config

journal

protected final SimFrameJournal<P extends Record> journal

Constructor Details

SimFramePlanner

public SimFramePlanner(NBBaseComponent parent,
 NBCommandParams analyzerParams)

Method Details

getConfig

public abstract C getConfig(NBCommandParams params)

initJournal

public SimFrameJournal<P> initJournal()

initialStep

public abstract P initialStep()

nextStep

public abstract P nextStep(JournalView<P> journal)

Using a stateful history of all control parameters and all results, decide if there is additional search space and return a set of parameters for the next workload simulation frame. If the stopping condition has been met, return null

Parameters:

journal - All parameters and results, organized in enumerated simulation frames

Returns:

Optionally, a set of paramValues which indicates another simulation frame should be sampled, else null

applyParams

public abstract void applyParams(P params,
 Activity activity)

analyze

public P analyze(Activity flywheel,
 SimFrameCapture capture,
 PrintWriter stdout,
 PrintWriter stderr,
 ContainerActivitiesController controller)