com.nsysmon

Interface NSysMonApi

All Known Implementing Classes:

NSysMonImpl

public interface NSysMonApi

Author:

arno

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)
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'.

Method Detail

getConfig

NSysMonConfig getConfig()

measure

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

Throws:

E extends Exception

measure

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

Throws:

E extends Exception

startFlow

void startFlow(ACorrelationId flowId)

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.

joinFlow

void joinFlow(ACorrelationId flowId)

start

ASimpleMeasurement start(String identifier)

start

ASimpleMeasurement start(String identifier,
                         boolean serial)

hasRunningMeasurement

boolean hasRunningMeasurement()

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

injectSyntheticMeasurement

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.

startCollectingMeasurement

ACollectingMeasurement startCollectingMeasurement(String identifier)

startCollectingMeasurement

ACollectingMeasurement startCollectingMeasurement(String identifier,
                                                  boolean serial)

getScalarMeasurements

Map<String,AScalarDataPoint> getScalarMeasurements()

getScalarMeasurements

Map<String,AScalarDataPoint> getScalarMeasurements(int averagingDelayForScalarsMillis)

getEnvironmentMeasurements

List<AEnvironmentData> getEnvironmentMeasurements()
                                           throws Exception

Throws:

Exception

getTimedScalarForDirectAccess

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

getTimedScalarMeasurements

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

getTimedScalarMeasurementsForMonitoring

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

addTimedScalarMeasurement

void addTimedScalarMeasurement(AScalarDataPoint... dataPoint)