Class RatchetPlanner

java.lang.Object

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

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

io.nosqlbench.scenarios.simframe.planning.SimFramePlanner<RatchetConfig,RatchetFrameParams>

io.nosqlbench.scenarios.simframe.optimizers.planners.ratchet.RatchetPlanner

All Implemented Interfaces:

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

public class RatchetPlanner
extends SimFramePlanner<RatchetConfig,RatchetFrameParams>

Nested Class Summary

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

NBLabeledElement.BasicLabeledElement

Field Summary

Fields inherited from class io.nosqlbench.scenarios.simframe.planning.SimFramePlanner

config, journal, 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
RatchetPlanner(NBBaseComponent parent, NBCommandParams params)

Method Summary

Modifier and Type	Method	Description
void	applyParams(RatchetFrameParams params, Activity flywheel)
RatchetConfig	getConfig(NBCommandParams params)
RatchetFrameParams	initialStep()
RatchetFrameParams	nextStep(JournalView<RatchetFrameParams> 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.scenarios.simframe.planning.SimFramePlanner

analyze, initJournal

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

Constructor Details

RatchetPlanner

public RatchetPlanner(NBBaseComponent parent,
 NBCommandParams params)

Method Details

getConfig

public RatchetConfig getConfig(NBCommandParams params)

Specified by:

getConfig in class SimFramePlanner<RatchetConfig,RatchetFrameParams>

initialStep

public RatchetFrameParams initialStep()

Specified by:

initialStep in class SimFramePlanner<RatchetConfig,RatchetFrameParams>

nextStep

public RatchetFrameParams nextStep(JournalView<RatchetFrameParams> 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

Specified by:

nextStep in class SimFramePlanner<RatchetConfig,RatchetFrameParams>

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 void applyParams(RatchetFrameParams params,
 Activity flywheel)

Specified by:

applyParams in class SimFramePlanner<RatchetConfig,RatchetFrameParams>