com.atlassian.confluence.util.profiling

Interface ConfluenceMonitoring

All Known Implementing Classes:

AtlassianInstrumentationConfluenceMonitoring

@Internal
 @ParametersAreNonnullByDefault
public interface ConfluenceMonitoring

Method Summary

Modifier and Type	Method and Description
String	createName(String name, String... optional) Creates a legal name from the supplied mandatory suggestion, and optional extra parts.
Counter	fetchCounter(String name, String... optional) Fetches the counter associated with the supplied name details.
Split	startSplit(String name, String... optional) Creates and starts a split timer associated with the supplied name details.

Method Detail

fetchCounter

@Nonnull
Counter fetchCounter(String name,
                              String... optional)

Fetches the counter associated with the supplied name details. The name is constructed calling createName(String, String...).

Parameters:

name - the mandatory suggested name

optional - the optional parts to concatenate with the mandatory suggestion

Returns:

the counter associated with the name.

startSplit

@Nonnull
Split startSplit(String name,
                          String... optional)

Creates and starts a split timer associated with the supplied name details. The name is constructed calling createName(String, String...).

The typical usage is:

 final Split split = instance.startSplit("name");
 try {
     // code to execute
 }
 finally {
     split.close();
 }
 

Under Java 7, the following is also possible:

 try (Split split = instance.startSplit("name")) {
     // code to execute
 }
 

Parameters:

name - the mandatory suggested name

optional - the optional parts to concatenate with the mandatory suggestion

Returns:

the running split timer

createName

@Nonnull
String createName(String name,
                           String... optional)

Creates a legal name from the supplied mandatory suggestion, and optional extra parts.

The method is provided for the case where the caller wants to pre-compute the name. For example, it maybe more efficient to generate the name once, to be re-used many times. Typically, this method will not be used.

The algorithm used is very simple:

• If the mandatory suggestion or the optional parts are null or a blank string, they are replaced with an empty string.
• The mandatory suggestion and the optional parts are concatenated together with a "." separator.
• All illegal characters are removed.
• If the end result is returned, unless it is an empty string, in which case <UNKNOWN> is returned instead.

Parameters:

name - the mandatory suggested name

optional - the optional parts to concatenate with the mandatory suggestion

Returns:

a legal name based on the inputs