com.nsysmon.impl

Class NSysMonImpl

java.lang.Object

com.nsysmon.impl.NSysMonImpl

All Implemented Interfaces:

NSysMonApi, AShutdownable

public class NSysMonImpl
extends Object
implements AShutdownable, NSysMonApi

This class is the point of contact for an application to NSysMon. There are basically two ways to use it:

• Use the static get() method to access it as a singleton. That is simple and convenient, and it is sufficient for many applications. If it is used that way, all configuration must be done through the static methods of ADefaultSysMonConfig.
• Create and manage your own instance (or instances) by calling the constructor, passing in your configuration. This is for maximum flexibility, but you lose some convenience.

Author:

arno

Constructor Summary

Constructors

Constructor and Description
NSysMonImpl(NSysMonConfig config)

Method Summary

Modifier and Type	Method and Description
void	addTimedScalarMeasurement(AScalarDataPoint... dataPoint)
NSysMonConfig	getConfig()
List<AEnvironmentData>	getEnvironmentMeasurements()
Map<String,AScalarDataPoint>	getScalarMeasurements()
Map<String,AScalarDataPoint>	getScalarMeasurements(int averagingDelayForScalarsMillis)
com.ajjpj.afoundation.collection.immutable.AList<RobustScalarMeasurerWrapper>	getTimedScalarForDirectAccess()
Map<String,com.ajjpj.afoundation.collection.mutable.ARingBuffer<AScalarDataPoint>>	getTimedScalarMeasurements()
Map<String,com.ajjpj.afoundation.collection.mutable.ARingBuffer<AScalarDataPoint>>	getTimedScalarMeasurementsForMonitoring()
boolean	hasRunningMeasurement() returns true iff a simple measurement is currently running for this thread
void	injectSyntheticMeasurement(AHierarchicalDataRoot d) This is for the rare case that measurement data was collected by other means and should be 'injected' into N-SysMon.
void	joinFlow(ACorrelationId flowId)
<R,E extends Exception> R	measure(String identifier, AMeasureCallback<R,E> callback)
<E extends Exception> void	measure(String identifier, AMeasureCallbackVoid<E> callback)
void	shutdown()
ASimpleMeasurement	start(String identifier)
ASimpleMeasurement	start(String identifier, boolean serial)
ACollectingMeasurement	startCollectingMeasurement(String identifier)
ACollectingMeasurement	startCollectingMeasurement(String identifier, boolean serial)
void	startFlow(ACorrelationId flowId) This tells N-SysMon that the currently running measurement starts a new 'flow'.

Methods inherited from class java.lang.Object

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

Constructor Detail

NSysMonImpl

public NSysMonImpl(NSysMonConfig config)

Method Detail

getConfig

public NSysMonConfig getConfig()

Specified by:

getConfig in interface NSysMonApi

measure

public <E extends Exception> void measure(String identifier,
                                          AMeasureCallbackVoid<E> callback)
                                   throws E extends Exception

Specified by:

measure in interface NSysMonApi

Throws:

E extends Exception

measure

public <R,E extends Exception> R measure(String identifier,
                                         AMeasureCallback<R,E> callback)
                                  throws E extends Exception

Specified by:

measure in interface NSysMonApi

Throws:

E extends Exception

start

public ASimpleMeasurement start(String identifier)

Specified by:

start in interface NSysMonApi

start

public ASimpleMeasurement start(String identifier,
                                boolean serial)

Specified by:

start in interface NSysMonApi

hasRunningMeasurement

public boolean hasRunningMeasurement()

Description copied from interface: NSysMonApi

returns true iff a simple measurement is currently running for this thread

Specified by:

hasRunningMeasurement in interface NSysMonApi

startFlow

public void startFlow(ACorrelationId flowId)

Description copied from interface: NSysMonApi

This tells N-SysMon that the currently running measurement starts a new 'flow'. Other measurements (in this or in another JVM) may 'join' that flow, so that these measurements can be evaluated at a later time. Typical examples of this is processing done in a spawned thread, batch processing that uses several worker threads, or asynchronous web service calls.

It is an invalid to call this method without a surrounding measurement, and doing so throws an exception.

Specified by:

startFlow in interface NSysMonApi

joinFlow

public void joinFlow(ACorrelationId flowId)

Specified by:

joinFlow in interface NSysMonApi

injectSyntheticMeasurement

public void injectSyntheticMeasurement(AHierarchicalDataRoot d)

This is for the rare case that measurement data was collected by other means and should be 'injected' into N-SysMon. If you do not understand this, this method is probably not for you.

Specified by:

injectSyntheticMeasurement in interface NSysMonApi

startCollectingMeasurement

public ACollectingMeasurement startCollectingMeasurement(String identifier)

Specified by:

startCollectingMeasurement in interface NSysMonApi

startCollectingMeasurement

public ACollectingMeasurement startCollectingMeasurement(String identifier,
                                                         boolean serial)

Specified by:

startCollectingMeasurement in interface NSysMonApi

getScalarMeasurements

public Map<String,AScalarDataPoint> getScalarMeasurements()

Specified by:

getScalarMeasurements in interface NSysMonApi

getScalarMeasurements

public Map<String,AScalarDataPoint> getScalarMeasurements(int averagingDelayForScalarsMillis)

Specified by:

getScalarMeasurements in interface NSysMonApi

getTimedScalarForDirectAccess

public com.ajjpj.afoundation.collection.immutable.AList<RobustScalarMeasurerWrapper> getTimedScalarForDirectAccess()

Specified by:

getTimedScalarForDirectAccess in interface NSysMonApi

getTimedScalarMeasurements

public Map<String,com.ajjpj.afoundation.collection.mutable.ARingBuffer<AScalarDataPoint>> getTimedScalarMeasurements()

Specified by:

getTimedScalarMeasurements in interface NSysMonApi

getTimedScalarMeasurementsForMonitoring

public Map<String,com.ajjpj.afoundation.collection.mutable.ARingBuffer<AScalarDataPoint>> getTimedScalarMeasurementsForMonitoring()

Specified by:

getTimedScalarMeasurementsForMonitoring in interface NSysMonApi

addTimedScalarMeasurement

public void addTimedScalarMeasurement(AScalarDataPoint... dataPoint)

Specified by:

addTimedScalarMeasurement in interface NSysMonApi

getEnvironmentMeasurements

public List<AEnvironmentData> getEnvironmentMeasurements()

Specified by:

getEnvironmentMeasurements in interface NSysMonApi

shutdown

public void shutdown()

Specified by:

shutdown in interface AShutdownable