com.atlassian.instrumentation.operations

Interface ThreadOpTimerFactory

All Superinterfaces:

OpTimerFactory

All Known Implementing Classes:

ThreadLocalOpTimerFactory

public interface ThreadOpTimerFactory
extends OpTimerFactory

This factory allows you to track values for a given thread. It can be used say for web request threads to know what operations happened on that thread of execution. You can snapshot it and then clear it at the end of the request.

Method Summary

Modifier and Type	Method and Description
OpTimer	createOpTimer(String name, boolean captureCPUCost, OpTimer.OnEndCallback endCallback) This creates an OpTimer based on the passed in name and that will invoke the callback when end is called.
OpRegistry	getOpRegistry()
List<OpSnapshot>	snapshotAndClear() This will snapshot the thread local OpRegistry and clear its contents.

Method Detail

createOpTimer

OpTimer createOpTimer(String name,
                      boolean captureCPUCost,
                      OpTimer.OnEndCallback endCallback)

Description copied from interface: OpTimerFactory

This creates an OpTimer based on the passed in name and that will invoke the callback when end is called.

Specified by:

createOpTimer in interface OpTimerFactory

Parameters:

name - the name of the OpTimer

captureCPUCost - true of the CPU cost of the operation is to be captured

endCallback - a call backed to be invokd when end is called on the OpTimer

Returns:

an OpTimer

getOpRegistry

OpRegistry getOpRegistry()

Returns:

the OpRegistry for the current thread

snapshotAndClear

List<OpSnapshot> snapshotAndClear()

This will snapshot the thread local OpRegistry and clear its contents.

You should call this say at the end of a request to get a snapshot of the counters for that request thread and then reset it for the next set of requests.

Returns:

a Mutable list of OpSnapshot objects for this thread