Class NBBaseComponent

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AtomicInput, BaseDriverAdapter, BaseOpDispenser, BobyqaOptimizerInstance, CapabilityHook, ClientSystemMetricChecker, ComputeFunctions, ConcurrentSpaceCache, ContainerActivitiesController, CqlUtils, CsvOutputPluginWriter, ExamplePlugin, HdrHistoLog, HistoStats, HttpPlugin, NBBufferedContainer, NBInvokableCommand, NBSessionSafetyMetrics, NBShutdownHook, NBStatusComponent, ParsedOp, S3Uploader, SimFramePlanner, SimRate, StringDriverSpaceCache, TestComponent, UnstartedPeriodicTaskComponent

public class NBBaseComponent
extends NBBaseComponentMetrics
implements NBComponent, NBTokenWords, NBComponentTimeline

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 boolean	bufferOrphanedMetrics
protected long	closed_ns
protected Exception	error
protected long	errored_ns
protected final NBLabels	labels
protected NBMetricsBuffer	metricsBuffer
protected final NBComponent	parent
protected long	started_epoch_ms
protected long	started_ns
protected NBInvokableState	state
protected long	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
NBBaseComponent(NBComponent parentComponent)
NBBaseComponent(NBComponent parentComponent, NBLabels componentSpecificLabelsOnly)
NBBaseComponent(NBComponent parentComponent, NBLabels componentSpecificLabelsOnly, Map<String,String> props)

Method Summary

Modifier and Type	Method	Description
void	addAdvisor(NBAdvisorPoint advisor)
void	addMetricsCloseable(MetricsCloseable metric)
NBComponent	attachChild(NBComponent... children)
void	beforeDetach()
final void	close()
NBCreators	create()
NBComponent	detachChild(NBComponent... children)
NBFinders	find()
<T> Optional<T>	findParentService(Class<T> type)
List<NBAdvisorPoint<?>>	getAdvisors()
List<NBComponent>	getChildren()
NBLabels	getComponentOnlyLabels()
Optional<String>	getComponentProp(String name)
NBInvokableState	getComponentState()
NBLabels	getLabels()
long	getNanosSinceStart()
NBComponent	getParent()
Map<String,String>	getTokens()
long	nanosof_close()	This will be 0L if the component hasn't began the process of closing down.
long	nanosof_error()	This will be 0L if the component hasn't logged an error.
long	nanosof_start()	This will be 0L if the component hasn't fully started, else it will be the System.nanoTime() of when the component entered its constructor
long	nanosof_teardown()	This will be 0L if the component hasn't completed teardown.
void	onError(Exception e)
void	onEvent(NBEvent event)
void	reportExecutionMetric(NBMetric m)	This method is called by the engine to report a component going out of scope.
NBComponentProps	setComponentProp(String name, String value)
long	started_epoch_ms()
protected void	teardown()	Override this method in your component implementations when you need to do something to close out your component.
String	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

parent

protected final NBComponent parent

labels

protected final NBLabels labels

metricsBuffer

protected NBMetricsBuffer metricsBuffer

bufferOrphanedMetrics

protected boolean bufferOrphanedMetrics

error

protected Exception error

started_ns

protected long started_ns

teardown_ns

protected long teardown_ns

closed_ns

protected long closed_ns

errored_ns

protected long errored_ns

started_epoch_ms

protected long started_epoch_ms

state

protected NBInvokableState state

Constructor Details

NBBaseComponent

public NBBaseComponent(NBComponent parentComponent)

NBBaseComponent

public NBBaseComponent(NBComponent parentComponent,
 NBLabels componentSpecificLabelsOnly)

NBBaseComponent

public NBBaseComponent(NBComponent parentComponent,
 NBLabels componentSpecificLabelsOnly,
 Map<String,String> props)

Method Details

getParent

public NBComponent getParent()

Specified by:

getParent in interface NBComponent

attachChild

public NBComponent attachChild(NBComponent... children)

Specified by:

attachChild in interface NBComponent

detachChild

public NBComponent detachChild(NBComponent... children)

Specified by:

detachChild in interface NBComponent

getChildren

public List<NBComponent> getChildren()

Specified by:

getChildren in interface NBComponent

getLabels

public NBLabels getLabels()

Specified by:

getLabels in interface NBLabeledElement

getComponentOnlyLabels

public NBLabels getComponentOnlyLabels()

Specified by:

getComponentOnlyLabels in interface NBComponent

beforeDetach

public void beforeDetach()

Specified by:

beforeDetach in interface NBComponent

close

public final void close()
                 throws RuntimeException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface NBComponent

Throws:

RuntimeException

onError

public void onError(Exception e)

teardown

protected void teardown()

Override this method in your component implementations when you need to do something to close out your component.

create

public NBCreators create()

Specified by:

create in interface NBComponentServices

find

public NBFinders find()

Specified by:

find in interface NBComponentServices

toString

public String toString()

Overrides:

toString in class Object

onEvent

public void onEvent(NBEvent event)

Specified by:

onEvent in interface NBComponentEvents

findParentService

public <T> Optional<T> findParentService(Class<T> type)

Specified by:

findParentService in interface NBProviderSearch

getTokens

public Map<String,String> getTokens()

Specified by:

getTokens in interface NBTokenWords

reportExecutionMetric

public void reportExecutionMetric(NBMetric m)

This method is called by the engine to report a component going out of scope. The metrics for that component will bubble up through the component layers and can be buffered for reporting at multiple levels.

Specified by:

reportExecutionMetric in interface NBComponent

Parameters:

m - The metric to report

getNanosSinceStart

public long getNanosSinceStart()

Specified by:

getNanosSinceStart in interface NBComponent

getComponentProp

public Optional<String> getComponentProp(String name)

Specified by:

getComponentProp in interface NBComponentProps

setComponentProp

public NBComponentProps setComponentProp(String name,
 String value)

Specified by:

setComponentProp in interface NBComponentProps

getComponentState

public NBInvokableState getComponentState()

Specified by:

getComponentState in interface NBComponentTimeline

nanosof_start

public long nanosof_start()

Description copied from interface: NBComponentTimeline

This will be 0L if the component hasn't fully started, else it will be the System.nanoTime() of when the component entered its constructor

Specified by:

nanosof_start in interface NBComponentTimeline

Returns:

nanosecond time of component construction

nanosof_close

public long nanosof_close()

Description copied from interface: NBComponentTimeline

This will be 0L if the component hasn't began the process of closing down.

Specified by:

nanosof_close in interface NBComponentTimeline

Returns:

nanosecond time of invoking close()

nanosof_teardown

public long nanosof_teardown()

Description copied from interface: NBComponentTimeline

This will be 0L if the component hasn't completed teardown. Otherwise it will be the System.nanoTime() when the base teardown logic in the component has completed. For this reason, it is imperative that any overrides to teardown() are called, and called last in the overridden teardown method.

Specified by:

nanosof_teardown in interface NBComponentTimeline

Returns:

nanosecond time of teardown completion

nanosof_error

public long nanosof_error()

Description copied from interface: NBComponentTimeline

This will be 0L if the component hasn't logged an error. Otherwise it will be the System.nanoTime() of when the error was reported.

Specified by:

nanosof_error in interface NBComponentTimeline

Returns:

nanosecond time of the error

started_epoch_ms

public long started_epoch_ms()

Specified by:

started_epoch_ms in interface NBComponentTimeline

addMetricsCloseable

public void addMetricsCloseable(MetricsCloseable metric)

addAdvisor

public void addAdvisor(NBAdvisorPoint advisor)

Specified by:

addAdvisor in interface NBComponentAdvisors

getAdvisors

public List<NBAdvisorPoint<?>> getAdvisors()

Specified by:

getAdvisors in interface NBComponentAdvisors