com.chemaxon.overlap.cli.prof

Class Prof

java.lang.Object

com.chemaxon.overlap.cli.prof.Prof

All Implemented Interfaces:

Closeable, AutoCloseable

public final class Prof
extends Object
implements Closeable

Utility methods for in-app profiling. Note that jstat (see http://docs.oracle.com/javase/1.5.0/docs/tooldocs/share/jstat.html) is a standard tool to do application profiling. This

Method Summary

Modifier and Type	Method and Description
void	addAdditionalData(String key, Object value) Add additional data to be included in the output.
void	addExtProbe(String groupName, Supplier<? extends Object> probe) Add additional probe.
void	close()
void	invokeSnapshot() Take a snapshot.
static Prof	launchProf(PrintStream ps, int dt) Launch profiling.
void	removeExtProbe(Supplier<? extends Object> probe) Remove additional probe.

Methods inherited from class java.lang.Object

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

Method Detail

addExtProbe

public void addExtProbe(String groupName,
                        Supplier<? extends Object> probe)

Add additional probe. Present probes will be added to a map of arrays in the final JSON referenced by ext with name as key.

Parameters:

groupName - Name of probe group

probe - Probe to add. Needs to be thread safe; will be invoked from inside an ExecutorService.

removeExtProbe

public void removeExtProbe(Supplier<? extends Object> probe)

Remove additional probe. All instances will be removed.

Parameters:

probe - Probe to remove.

addAdditionalData

public void addAdditionalData(String key,
                              Object value)

Add additional data to be included in the output. Data will be printed on invoking close().

Parameters:

key - Key

value - Value

launchProf

public static Prof launchProf(PrintStream ps,
                              int dt)

Launch profiling.

Parameters:

ps - PrintStream to write profiling results. Will be closed upon calling close().

dt - Delay between writes in ms

Returns:

Prof instance representing the profile collection

invokeSnapshot

public void invokeSnapshot()

Take a snapshot. This method returns after snapshot is taken. The taken snapshot will be marked as important.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable