de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies

Interface RecorderStrategy

All Known Implementing Classes:

AbstractEventRecorderStrategy, AbstractRecorderStrategy, DefaultEventRecorderStrategy, DefaultRecorderStrategy, TCPRecorderStrategy

public interface RecorderStrategy

A pluggable strategy which implements recording. This interface was introduced because network monitoring should be transparently supported as well as in-memory-recording. Thus, this interface must not provide access to monitoring groups.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
static int	REGISTER_END Force thread end.
static int	REGISTER_FORCE Force thread registration.

Method Summary

Modifier and Type	Method and Description
boolean	assignAllTo(java.lang.String recId, boolean enter, long now, ThreadsInfo threadInfo) Notifies that the following values (if not further calls to this method or other recording ids occur) should be assigned to the given recId.
void	clearTemporaryData() Notify that temporary data e.g. from instrumentation shall be cleared.
void	enableVariabilityDetection(boolean enable) Enables or disables automatic variability detection.
void	endSystem() Called as the last event from the monitored program.
boolean	enter(java.lang.String recId, long now, ThreadsInfo threadsInfo, boolean exclude) Notifies the recorder about a method being called.
void	enterConfiguration(java.lang.String id) Notify the recorder that a new variability configuration might have been entered.
boolean	exit(java.lang.String recId, long now, ThreadsInfo threadsInfo, boolean exclude) Notifies the recorder about a method being exited.
boolean	finishRecording(long now, long threadId, LongLongHashMap curCpuTime) Notifies this strategy that recording should be stopped (second stage of stopping the recorder).
java.lang.String	getRecorderId(java.lang.String className) Maps a class name to its recorder id (called in this interface usually recId).
StrategyStorage	getStorage() Returns the attached storage.
char	getVariabilitySeparatorChar() Returns the char used for separating the variability id and its current value (in configurations).
boolean	isVariabilityDetectionEnabled() Returns if automatic variability detection is enabled.
void	memoryAllocated(java.lang.String recId, long threadId, long id, long size) Notifies the recorder about an object allocated to memory.
void	memoryFreedByRecId(java.lang.String recId, long size) Notifies the recorder about an object freed from memory.
void	notifyProgramRecordCreation() Notify the listeners about the program record creation (if not done implicitly before).
void	notifyTimer(java.lang.String id, TimerState state, long now, long threadId) Notifies about a timer event.
void	notifyValueChange(java.lang.String id, ValueType type, java.lang.Object value) Notifies about a changing attribute value.
boolean	printCurrentState(ProcessData data) Prints the current (aggregated) state to the output formatter.
boolean	printStatistics(ProcessData data) Emits the values collected so far.
void	readIo(java.lang.String recId, java.lang.String caller, long threadId, int bytes, StreamType type) Notifies the recorder about an amount of bytes read from some I/O channel.
void	register(long threadId, long newId, long threadTicks, long now) Registers a thread id with a recording id.
void	registerForRecording(java.lang.String className, java.lang.String recId, MonitoringGroupConfiguration conf, MonitoringGroupSettings settings) Registers a given class for recording.
void	startRecording(long now, long threadId, long threadTicks) Notifies this strategy that recording should be start.
boolean	stopTimeRecording(long now, ThreadsInfo threadsInfo) Notifies this strategy that time recording should be stopped (first stage of stopping the recorder).
void	writeIo(java.lang.String recId, java.lang.String caller, long threadId, int bytes, StreamType type) Notifies the recorder about an amount of bytes written to some I/O channel.

Field Detail

REGISTER_FORCE

static final int REGISTER_FORCE

Force thread registration. To be used with register(long, long, long, long)

See Also:

Constant Field Values

REGISTER_END

static final int REGISTER_END

Force thread end. To be used with register(long, long, long, long)

See Also:

Constant Field Values

Method Detail

writeIo

void writeIo(java.lang.String recId,
             java.lang.String caller,
             long threadId,
             int bytes,
             StreamType type)

Notifies the recorder about an amount of bytes written to some I/O channel.

Parameters:

recId - a unique identification where to assign this event to

caller - optional class name of the calling class

threadId - the identification of the calling thread

bytes - the number of bytes

type - the type of the channel

Since:

1.00

readIo

void readIo(java.lang.String recId,
            java.lang.String caller,
            long threadId,
            int bytes,
            StreamType type)

Notifies the recorder about an amount of bytes read from some I/O channel.

Parameters:

recId - a unique identification where to assign this event to

caller - optional class name of the calling class

threadId - the identification of the calling thread

bytes - the number of bytes

type - the type of the channel

Since:

1.00

memoryFreedByRecId

void memoryFreedByRecId(java.lang.String recId,
                        long size)

Notifies the recorder about an object freed from memory. Please note that dependent on the concrete instrumentation not all memory frees might be detected, e.g. those of immediate system classes (e.g. Object cannot be instrumented).

Parameters:

recId - a unique identification where to assign this event to

size - the affected amount of bytes in memory

Since:

1.00

memoryAllocated

void memoryAllocated(java.lang.String recId,
                     long threadId,
                     long id,
                     long size)

Notifies the recorder about an object allocated to memory. Please note that dependent on the concrete instrumentation not all allocated objects might be cleaned up.

Parameters:

recId - a unique identification where to assign this event to

threadId - the identification of the calling thread

id - the unique identification of the object being allocated

size - the affected amount of bytes in memory

Since:

1.00

exit

boolean exit(java.lang.String recId,
             long now,
             ThreadsInfo threadsInfo,
             boolean exclude)

Notifies the recorder about a method being exited.

Parameters:

recId - a unique identification where to assign this event to

now - the current time in nano seconds

threadsInfo - information on the currently running threads

exclude - is this an exclusion from monitoring

Returns:

true if the threadsInfo object should be released to the pool, false if it should not be released

Since:

1.00

register

void register(long threadId,
              long newId,
              long threadTicks,
              long now)

Registers a thread id with a recording id. This method is used to assign unregistered method calls to monitored threads as well as to register system threads.

Parameters:

threadId - the read id to be recorded

newId -

• if positive, the new thread
• if REGISTER_FORCE the thread specified by threadId and threadTicks is registered with the recorder
• if REGISTER_END the thread specified by threadId and threadTicks is marked as terminated in the recorder

threadTicks - the ticks of threadId

now - the current time in nano seconds

Since:

1.00

enter

boolean enter(java.lang.String recId,
              long now,
              ThreadsInfo threadsInfo,
              boolean exclude)

Notifies the recorder about a method being called.

Parameters:

recId - a unique identification where to assign this event to

now - the current system time in nano seconds

threadsInfo - information on the currently running threads

exclude - is this an exclusion from monitoring

Returns:

true if the threadsInfo object should be released to the pool, false if it should not be released

Since:

1.00

assignAllTo

boolean assignAllTo(java.lang.String recId,
                    boolean enter,
                    long now,
                    ThreadsInfo threadInfo)

Notifies that the following values (if not further calls to this method or other recording ids occur) should be assigned to the given recId.

Parameters:

recId - the recording id (may be also the variability prefix)

enter - true if this is a method enter event, false else

now - the current system time

threadInfo - information on the current thread

Returns:

true if the threadsInfo object should be released to the pool, false if it should not be released

Since:

1.00

printStatistics

boolean printStatistics(ProcessData data)

Emits the values collected so far.

Parameters:

data - additional information collected for system and JVM process

Returns:

true if the data object should be released to the pool, false if it should not be released

Since:

1.00

endSystem

void endSystem()

Called as the last event from the monitored program. This is after finishRecording(long, long, de.uni_hildesheim.sse.monitoring.runtime.utils.LongLongHashMap) and optionally printStatistics(de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.ProcessData).

Since:

1.00

stopTimeRecording

boolean stopTimeRecording(long now,
                          ThreadsInfo threadsInfo)

Notifies this strategy that time recording should be stopped (first stage of stopping the recorder).

Parameters:

now - the current time in nano seconds

threadsInfo - information on the currently running threads

Returns:

true if the threadsInfo object should be released to the pool, false if it should not be released

Since:

1.00

finishRecording

boolean finishRecording(long now,
                        long threadId,
                        LongLongHashMap curCpuTime)

Notifies this strategy that recording should be stopped (second stage of stopping the recorder).

Parameters:

now - the current time in nano seconds

threadId - the id of the current thread

curCpuTime - the id-cpu time mapping of all threads

Returns:

true if the curCpuTime object should be released to the pool, false if it should not be released

Since:

1.00

startRecording

void startRecording(long now,
                    long threadId,
                    long threadTicks)

Notifies this strategy that recording should be start.

Parameters:

now - the current time in nano seconds

threadId - the thread id of the executing (main) thread

threadTicks - the thread ticks for threadId

Since:

1.00

registerForRecording

void registerForRecording(java.lang.String className,
                          java.lang.String recId,
                          MonitoringGroupConfiguration conf,
                          MonitoringGroupSettings settings)

Registers a given class for recording. Optional, a (group) id might be specified to which the measurements are assigned to. Ids are unique strings without inherent semantics. If not given, the className is used for grouping and assigning measurements (implicit 1-groups).

Parameters:

className - the name of the class measurements should be registered for

recId - an optional group identification (may be empty or null)

conf - additional configuration for the monitoring group derived from settings

settings - the monitoring group settings including all configuration information (reference should not be stored, will be freed explicitly)

Since:

1.00

enterConfiguration

void enterConfiguration(java.lang.String id)

Notify the recorder that a new variability configuration might have been entered. The recorder should resolve the concrete configuration by tracking the configuration activations.

Parameters:

id - an optional group identification (may be empty or null)

Since:

1.00

getRecorderId

java.lang.String getRecorderId(java.lang.String className)

Maps a class name to its recorder id (called in this interface usually recId).

Parameters:

className - the class name to be mapped

Returns:

the recorder id of className

Since:

1.00

getVariabilitySeparatorChar

char getVariabilitySeparatorChar()

Returns the char used for separating the variability id and its current value (in configurations).

Returns:

the separator char

Since:

1.00

enableVariabilityDetection

void enableVariabilityDetection(boolean enable)

Enables or disables automatic variability detection.

Parameters:

enable - true if variability detection should be enabled, false else

Since:

1.00

isVariabilityDetectionEnabled

boolean isVariabilityDetectionEnabled()

Returns if automatic variability detection is enabled.

Returns:

true if variability detection should be enabled, false else

Since:

1.00

printCurrentState

boolean printCurrentState(ProcessData data)

Prints the current (aggregated) state to the output formatter.

Parameters:

data - additional information collected for system and JVM process (may be null)

Returns:

true if the threadsInfo object should be released to the pool, false if it should not be released

Since:

1.00

notifyTimer

void notifyTimer(java.lang.String id,
                 TimerState state,
                 long now,
                 long threadId)

Notifies about a timer event.

Parameters:

id - the timer identification (may overlap with recorder ids)

state - the new timer state

now - the current system time in milliseconds

threadId - the id of the currently executing thread, may be negative if it should be ignored

Since:

1.00

notifyValueChange

void notifyValueChange(java.lang.String id,
                       ValueType type,
                       java.lang.Object value)

Notifies about a changing attribute value.

Parameters:

id - the identification of the attribute (may overlap with recorder ids)

type - the type of the value

value - the new value (after changing)

Since:

1.00

notifyProgramRecordCreation

void notifyProgramRecordCreation()

Notify the listeners about the program record creation (if not done implicitly before).

clearTemporaryData

void clearTemporaryData()

Notify that temporary data e.g. from instrumentation shall be cleared. This is in particular required to synchronize event-based implementations.

Since:

1.00

getStorage

StrategyStorage getStorage()

Returns the attached storage.

Returns:

the attached storage

Since:

1.00