Package com.atlassian.util.profiling

Class Timers

java.lang.Object

com.atlassian.util.profiling.Timers

@Internal
@ParametersAreNonnullByDefault
public class Timers
extends Object

Factory and utility methods for create Timer instances

     try (Ticker ignored = Timers.start("my-timer")) {
         // monitored code block here
     }
 

Since:

3.0.0

Method Summary

Modifier and Type	Method	Description
static Timer	concat(Timer... timers)	Combine multiple Timer objects into one, so they can be started and stopped together.
static ProfilerConfiguration	getConfiguration()	Get the current ProfilerConfiguration.
static void	onRequestEnd()	Call this method to signal that the request has completed to trigger all configured profiler strategies and metric strategies to clean up any request or thread scoped resources associated with profiling state, including closing any tickers that have not yet been closed.
static Ticker	start(String name)	Starts a timer with the given name.
static Ticker	startWithMetric(String timerName)	Starts a timer with the given name and metrics.
static Ticker	startWithMetric(String timerName, MetricTag.RequiredMetricTag... metricTags)	Deprecated. since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.
static Ticker	startWithMetric(String timerName, String metricName)	Deprecated. since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.
static Ticker	startWithMetric(String timerName, String metricName, MetricTag.RequiredMetricTag... metricTags)	Deprecated. since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.
static Timer	timer(String name)	Creates a Timer with the given name.
static Timer	timerWithMetric(String name)	Creates a Timer with the given name, and metrics.
static Timer	timerWithMetric(String traceName, Metrics.Builder metricBuilder)	Creates a Timer with the given trace name, and metrics based on the builder.
static Timer	timerWithMetric(String name, MetricTag.RequiredMetricTag... tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.
static Timer	timerWithMetric(String traceName, MetricTimer metricTimer)	Creates a Timer with the given trace name, and mixes in a MetricTimer.
static Timer	timerWithMetric(String traceName, String metricName)	Deprecated. since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.
static Timer	timerWithMetric(String traceName, String metricName, MetricTag.RequiredMetricTag... tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.
static Timer	timerWithMetric(String traceName, String metricName, Collection<MetricTag.RequiredMetricTag> tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.
static Timer	timerWithMetric(String name, Collection<MetricTag.RequiredMetricTag> tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.

Methods inherited from class java.lang.Object

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

Method Details

concat

@Nonnull
public static Timer concat(Timer... timers)

Combine multiple Timer objects into one, so they can be started and stopped together.

Parameters:

timers - to combine

Returns:

a composite Timer

Since:

3.0.0

getConfiguration

@Nonnull
public static ProfilerConfiguration getConfiguration()

Get the current ProfilerConfiguration.

Returns:

the current configuration.

Since:

3.0.0

onRequestEnd

public static void onRequestEnd()

Call this method to signal that the request has completed to trigger all configured profiler strategies and metric strategies to clean up any request or thread scoped resources associated with profiling state, including closing any tickers that have not yet been closed.

Since:

3.0.0

start

@Nonnull
public static Ticker start(String name)

Starts a timer with the given name.

Returns:

a Ticker to stop the created and started timer.

Since:

3.0.0

startWithMetric

@Nonnull
public static Ticker startWithMetric(String timerName)

Starts a timer with the given name and metrics.

Returns:

a Ticker to stop the created and started timer.

Since:

3.0.0

startWithMetric

@Deprecated
@Nonnull
public static Ticker startWithMetric(String timerName,
 String metricName)

Deprecated.

since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.

Starts a timer with the given name and metrics with the given metric name.

Returns:

a Ticker to stop the created and started timer.

Since:

3.0.0

startWithMetric

@Deprecated
@Nonnull
public static Ticker startWithMetric(String timerName,
 MetricTag.RequiredMetricTag... metricTags)

Deprecated.

since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.

Starts a timer with the given name, and tagged metrics.

See Metrics.Builder.tags(Iterable) for more information about tag behaviour.

Returns:

a Ticker to stop the created and started timer.

Since:

3.4.2

startWithMetric

@Deprecated
@Nonnull
public static Ticker startWithMetric(String timerName,
 String metricName,
 MetricTag.RequiredMetricTag... metricTags)

Deprecated.

since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.

Starts a timer with the given name, and tagged metrics with the given metric name.

See Metrics.Builder.tags(Iterable) for more information about tag behaviour.

Returns:

a Ticker to stop the created and started timer.

Since:

3.4.1

timer

@Nonnull
public static Timer timer(String name)

Creates a Timer with the given name.

Returns:

the created Timer.

Since:

3.0.0

timerWithMetric

@Deprecated
@Nonnull
public static Timer timerWithMetric(String traceName,
 String metricName)

Deprecated.

since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.

Creates a Timer with the given trace name, and metrics with given metric name.

Returns:

the created Timer.

Since:

3.0.0

timerWithMetric

@Deprecated
@Nonnull
public static Timer timerWithMetric(String traceName,
 String metricName,
 MetricTag.RequiredMetricTag... tags)

Deprecated.

since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.

Creates a Timer with the given trace name, and tagged metrics with the given metric name.

See Metrics.Builder.tags(Iterable) for more information about tag behaviour.

Returns:

the created Timer.

Since:

3.4.0

timerWithMetric

@Deprecated
@Nonnull
public static Timer timerWithMetric(String traceName,
 String metricName,
 Collection<MetricTag.RequiredMetricTag> tags)

Deprecated.

since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.

Creates a Timer with the given trace name, and tagged metrics with the given metric name.

See Metrics.Builder.tags(Iterable) for more information about tag behaviour.

Returns:

the created Timer.

Since:

3.4.0

timerWithMetric

@Nonnull
public static Timer timerWithMetric(String traceName,
 Metrics.Builder metricBuilder)

Creates a Timer with the given trace name, and metrics based on the builder.

See Metrics.Builder.tags(Iterable) for more information about tag behaviour.

Returns:

the created Timer.

Since:

3.5.0

timerWithMetric

@Nonnull
public static Timer timerWithMetric(String traceName,
 MetricTimer metricTimer)

Creates a Timer with the given trace name, and mixes in a MetricTimer.

Returns:

the created Timer.

Since:

3.5.0

timerWithMetric

@Nonnull
public static Timer timerWithMetric(String name)

Creates a Timer with the given name, and metrics.

Returns:

a Ticker to stop the created timer.

Since:

3.0.0

timerWithMetric

@Deprecated
@Nonnull
public static Timer timerWithMetric(String name,
 Collection<MetricTag.RequiredMetricTag> tags)

Deprecated.

since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.

Creates a Timer with the given name, and tagged metrics.

See Metrics.Builder.tags(Iterable) for more information about tag behaviour.

Returns:

the created Timer.

Since:

3.4.0

timerWithMetric

@Deprecated
@Nonnull
public static Timer timerWithMetric(String name,
 MetricTag.RequiredMetricTag... tags)

Deprecated.

since 4.3.0, for removal in 5.0.0, use timerWithMetric(String, Metrics.Builder) with the Metrics.metric(String) builder instead.

Creates a Timer with the given name, and tagged metrics.

See Metrics.Builder.tags(Iterable) for more information about tag behaviour.

Returns:

the created Timer.

Since:

3.4.0