com.atlassian.instrumentation.operations.registry

Class OpRegistry

java.lang.Object

com.atlassian.instrumentation.operations.registry.OpRegistry

public class OpRegistry
extends Object

This is a glorified Map/Set of OpCounter's that are in some way related.

It can create new OpCounter objects directly via is pull() methods. This makes it easier to manage the creation of performance statistics.

Its just a fraction easier to use than a raw map plus is has thread safety.

Since:

v4.0

Constructor Summary

Constructors

Constructor and Description
OpRegistry()

Method Summary

Modifier and Type	Method and Description
void	add(List<OpSnapshot> opSnapshotList) This will "pull" a List of OpSnapshot objects into the current registry
OpCounter	add(OpCounter srcOpCounter) This will "pull" a counter into the registry and add the value of the OpCounter to it.
void	add(OpRegistry srcOpRegistry) This will "pull" all the counters out of the passed in OpRegistry and add the values to counters under the same names in the current registry.
OpCounter	add(OpSnapshot srcOpSnapshot) This will "pull" a counter into the registry and add the value of the OpCounter to it.
OpCounter	get(String opName) Returns the OpCounter under the specified name or null if its not present.
OpCounter	pull(String opName) This is a pull through operation that guarantees to ATOMICALLy create an OpCounter under the name if its not present OR return the previously created one if its there.
OpTimer	pullTimer(String name) Call this method to start an OpTimer.
OpCounter	put(OpCounter opCounter) Can be called to PUT a counter into the registry.
List<OpSnapshot>	snapshot() This returns a List of OpSnapshot objects that represent the values of the all the OpCounter's in the OpRegistry at the time the method was called.
List<OpSnapshot>	snapshotAndClear() This returns a List of OpSnapshot objects that represent the values of the all the OpCounter's in the OpRegistry at the time the method was called and then clears the internal list of counters.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OpRegistry

public OpRegistry()

Method Detail

put

public OpCounter put(OpCounter opCounter)

Can be called to PUT a counter into the registry. This has normal map-like behaviour. The key used is the name of the OpCounter

THREAD-SAFE - Uses ConcurrentHashMap under the covers

Parameters:

opCounter - the counter in question - It must NOT be null

Returns:

the previous OpCounter value

get

public OpCounter get(String opName)

Returns the OpCounter under the specified name or null if its not present. This has normal map behaviour.

THREAD-SAFE - Uses ConcurrentHashMap under the covers

Parameters:

opName - the name of the counter to retrieve. It must not be null.

Returns:

an OpCounter associated with the key or null

pullTimer

public OpTimer pullTimer(String name)

Call this method to start an OpTimer. When the end() method is called the OpSnapshot will be pulled into OpRegistry.

 OpTimer timer = registry.pullTimer("opName");
 ...
 ... // do some work
 ...
 timer.end();
 //
 // the timer values will now be pulled into the
 // registry under the name "opName"
 

Parameters:

name - the name of the operation

Returns:

an running OpTimer.

pull

public OpCounter pull(String opName)

This is a pull through operation that guarantees to ATOMICALLy create an OpCounter under the name if its not present OR return the previously created one if its there.

THREAD-SAFE - Uses ConcurrentHashMap under the covers

Parameters:

opName - the name of the operation

Returns:

a NON NULL OpCounter guaranteed

add

public OpCounter add(OpCounter srcOpCounter)

This will "pull" a counter into the registry and add the value of the OpCounter to it.

Parameters:

srcOpCounter - the source OpCounter to get values from to

Returns:

the OpCounter that was pulled from the OpRegistry with the values added to it

add

public OpCounter add(OpSnapshot srcOpSnapshot)

This will "pull" a counter into the registry and add the value of the OpCounter to it.

Parameters:

srcOpSnapshot - the source OpSnapshot to get values from to

Returns:

the OpCounter that was pulled from the OpRegistry with the values added to it

add

public void add(OpRegistry srcOpRegistry)

This will "pull" all the counters out of the passed in OpRegistry and add the values to counters under the same names in the current registry. It uses "pull" to do this, and hence they will be created as necessary.

THREAD-SAFETY - Since the srcOpRegistry is mutable, it can only get a snapshot of the other registry at a point in time.

Parameters:

srcOpRegistry - the registry to copy values from

add

public void add(List<OpSnapshot> opSnapshotList)

This will "pull" a List of OpSnapshot objects into the current registry

Parameters:

opSnapshotList - a List of OpSnapshot objects

snapshot

public List<OpSnapshot> snapshot()

This returns a List of OpSnapshot objects that represent the values of the all the OpCounter's in the OpRegistry at the time the method was called.

The list is MUTABLE and a copy of the OpCounter values. So feel free to mutate it by sorting it and filtering it.

Returns:

a mutable List of OpSnapshot objects

snapshotAndClear

public List<OpSnapshot> snapshotAndClear()

This returns a List of OpSnapshot objects that represent the values of the all the OpCounter's in the OpRegistry at the time the method was called and then clears the internal list of counters.

The list is MUTABLE and a copy of the OpCounter values. So feel free to mutate it by sorting it and filtering it.

Returns:

a mutable List of OpSnapshot objects

toString

public String toString()

Overrides:

toString in class Object