Package org.eclipse.steady.java.monitor

Class InstrumentationControl

java.lang.Object

org.eclipse.steady.java.monitor.InstrumentationControl

public class InstrumentationControl
extends Object

Controls whether or not a given Java class is instrumented. To that end, it uses a couple of blacklists and whitelists read from the configuration. Moreover, it maintains statistics to report on the overall number of classes and constructs instrumented.

See Also:

DynamicTransformer, JarAnalyzer, WarAnalyzer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InstrumentationControl.InstrumentationMetrics

Method Summary

Modifier and Type	Method	Description
int	countClassesInstrumentedAlready()	Returns the number of classes that were already instrumented.
int	countClassesInstrumentedFailure()	Returns the number of classes that could not be instrumented.
int	countClassesInstrumentedSuccess()	Returns the number of classes that were successfully instrumented.
int	countClassesTotal()	Returns the total number of classes looked at.
Set<JavaId>	getFailedInstrumentations()	Returns the classes which could not be instrumented, hence, for which no traces or other information could be collected.
static InstrumentationControl	getInstance()	getInstance.
static InstrumentationControl	getInstance(Object _context)	getInstance.
long	getMetric(InstrumentationControl.InstrumentationMetrics _metric)	getMetric.
static Map<String,Long>	getOverallStatistics()	getOverallStatistics.
Map<InstrumentationControl.InstrumentationMetrics,Long>	getStatistics()	getStatistics.
boolean	isBlacklistedClass(String _qname)	Returns true if the class with the specified qualified name is blacklisted, false otherwise.
boolean	isBlacklistedJar(URL _url)	Returns true if the JAR at the specified path is blacklisted, false otherwise.
static void	logOverallStatistics()	logOverallStatistics.
void	logStatistics()	Logs various statistics, depending on the log level.
void	updateInstrumentationStatistics(JavaId _jcid, Boolean _instr_successful)	Updates the statistics depending on whether the instrumentation of the given Java class succeeded or not.

Methods inherited from class java.lang.Object

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

Method Detail

updateInstrumentationStatistics

public void updateInstrumentationStatistics(JavaId _jcid,
                                            Boolean _instr_successful)

Updates the statistics depending on whether the instrumentation of the given Java class succeeded or not.

Parameters:

_jcid - the class that was instrumented successfully or not

_instr_successful - null if the class was already instrumented, or true/false if the instrumentation was done in this transformer

logStatistics

public void logStatistics()

Logs various statistics, depending on the log level. Called by UploadScheduler.run().

getMetric

public long getMetric(InstrumentationControl.InstrumentationMetrics _metric)

getMetric.

Parameters:

_metric - a InstrumentationControl.InstrumentationMetrics object.

Returns:

a long.

getStatistics

public Map<InstrumentationControl.InstrumentationMetrics,Long> getStatistics()

getStatistics.

Returns:

a Map object.

isBlacklistedJar

public boolean isBlacklistedJar(URL _url)

Returns true if the JAR at the specified path is blacklisted, false otherwise. A JAR is blacklisted if the file name matches any of the patterns specified with configuration parameter instr.blacklist.jars, or if it resides in a directory (or subdirectory) of any of the paths specified with instr.blacklist.dirs.

Parameters:

_url - a URL object.

Returns:

a boolean.

isBlacklistedClass

public boolean isBlacklistedClass(String _qname)

Returns true if the class with the specified qualified name is blacklisted, false otherwise. A qualified name is blacklisted if its package (or any of its parent packages) is specified as part of the configuration parameters instr.blacklist.classes.jre or instr.blacklist.classes.custom.

Parameters:

_qname - a String object.

Returns:

a boolean.

countClassesTotal

public int countClassesTotal()

Returns the total number of classes looked at.

Returns:

a int.

countClassesInstrumentedAlready

public int countClassesInstrumentedAlready()

Returns the number of classes that were already instrumented.

Returns:

a int.

See Also:

updateInstrumentationStatistics(JavaId, Boolean)

countClassesInstrumentedSuccess

public int countClassesInstrumentedSuccess()

Returns the number of classes that were successfully instrumented.

Returns:

a int.

See Also:

updateInstrumentationStatistics(JavaId, Boolean)

countClassesInstrumentedFailure

public int countClassesInstrumentedFailure()

Returns the number of classes that could not be instrumented.

Returns:

a int.

See Also:

updateInstrumentationStatistics(JavaId, Boolean)

getFailedInstrumentations

public Set<JavaId> getFailedInstrumentations()

Returns the classes which could not be instrumented, hence, for which no traces or other information could be collected.

Returns:

a Set object.

getInstance

public static InstrumentationControl getInstance()

getInstance.

Returns:

a InstrumentationControl object.

getInstance

public static InstrumentationControl getInstance(Object _context)

getInstance.

Parameters:

_context - a Object object.

Returns:

a InstrumentationControl object.

getOverallStatistics

public static Map<String,Long> getOverallStatistics()

getOverallStatistics.

Returns:

a Map object.

logOverallStatistics

public static void logOverallStatistics()

logOverallStatistics.