Package com.atlassian.confluence.util.profiling

Interface ConfluenceMonitoring

All Known Implementing Classes:

AtlassianInstrumentationConfluenceMonitoring

@Internal
@ParametersAreNonnullByDefault
public interface ConfluenceMonitoring

Method Summary

Modifier and Type	Method	Description
default @NonNull String	createName(String name, String... optional)	Creates a legal name from the supplied mandatory suggestion, and optional extra parts.
default @NonNull Counter	fetchCounter(String name)	Fetches the counter associated with the supplied name details.
@NonNull Counter	fetchCounter(String name, String... optional)	Deprecated. since 7.1 Use fetchCounter(String, Map)
@NonNull Counter	fetchCounter(String name, Map<String,String> tags)	Fetches the counter associated with the supplied name details.
default @NonNull Split	startSplit(String name)	Creates and starts a split timer associated with the supplied name details.
@NonNull Split	startSplit(String name, String... optional)	Deprecated. since 7.1 Use startSplit(String, Map)
@NonNull Split	startSplit(String name, Map<String,String> tags)	Creates and starts a split timer associated with the supplied name details.

Method Detail

fetchCounter

@Deprecated
@NonNull Counter fetchCounter(String name,
                              String... optional)

Deprecated.

since 7.1 Use fetchCounter(String, Map)

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.

fetchCounter

default @NonNull Counter fetchCounter(String name)

Fetches the counter associated with the supplied name details.

Parameters:

name - the mandatory suggested name

Returns:

the counter associated with the name.

Since:

7.1

fetchCounter

@NonNull Counter fetchCounter(String name,
                              Map<String,String> tags)

Fetches the counter associated with the supplied name details.

Parameters:

name - the mandatory suggested name

tags - the name-value tags to apply

Returns:

the counter associated with the name.

Since:

7.1

startSplit

@Deprecated
@NonNull Split startSplit(String name,
                          String... optional)

Deprecated.

since 7.1 Use startSplit(String, Map)

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

The typical usage is:

 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

startSplit

default @NonNull Split startSplit(String name)

Creates and starts a split timer associated with the supplied name details.

The typical usage is:

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

Parameters:

name - the mandatory suggested name

Returns:

the running split timer

Since:

7.1

startSplit

@NonNull Split startSplit(String name,
                          Map<String,String> tags)

Creates and starts a split timer associated with the supplied name details.

The typical usage is:

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

Parameters:

name - the mandatory suggested name

tags - the name-value tags to apply

Returns:

the running split timer

Since:

7.1

createName

default @NonNull String createName(String name,
                                   String... optional)

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

Parameters:

name - the mandatory suggested name

optional - the optional parts to concatenate with the mandatory suggestion

Returns:

a legal name based on the inputs