com.atlassian.instrumentation.operations

Class ThreadLocalOpTimerFactory

java.lang.Object

com.atlassian.instrumentation.operations.ThreadLocalOpTimerFactory

All Implemented Interfaces:

OpTimerFactory, ThreadOpTimerFactory

public class ThreadLocalOpTimerFactory
extends Object
implements ThreadOpTimerFactory

ThreadOpTimerFactory that is implemented using a ThreadLocal. Clients must call snapshotAndClear() in a finally block after each request to ensure that the thread local storage is removed. Failure to do so will result in memory leaks.

Constructor Summary

Constructors

Constructor and Description
ThreadLocalOpTimerFactory()

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 remove its associated storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadLocalOpTimerFactory

public ThreadLocalOpTimerFactory()

Method Detail

createOpTimer

public 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

Specified by:

createOpTimer in interface ThreadOpTimerFactory

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

public OpRegistry getOpRegistry()

Specified by:

getOpRegistry in interface ThreadOpTimerFactory

Returns:

the OpRegistry for the current thread

snapshotAndClear

public List<OpSnapshot> snapshotAndClear()

This will snapshot the thread local OpRegistry and remove its associated storage.

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

Specified by:

snapshotAndClear in interface ThreadOpTimerFactory

Returns:

a mutable list of OpSnapshot objects for this thread