Package com.atlassian.util.profiling

Class Metrics

java.lang.Object

com.atlassian.util.profiling.Metrics

@Internal
@ParametersAreNonnullByDefault
public class Metrics
extends Object

Factory and utility methods for creating MetricTimer, LongRunningMetricTimer, and Histogram. Please move to using the builder.

     try (Ticker autoclosed = Metrics.metric("my-timer").startTimer()) {
         // monitored code block here
     }
 

Since:

3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Metrics.Builder	A metric builder, to get started call metric(String).

Method Summary

Modifier and Type	Method	Description
static MetricsConfiguration	getConfiguration()	Get the current MetricsConfiguration.
static Histogram	histogram(String name)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static Histogram	histogram(String name, MetricTag.RequiredMetricTag... tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static Histogram	histogram(String name, Collection<MetricTag.RequiredMetricTag> tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static LongRunningMetricTimer	longRunningTimer(String name)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static LongRunningMetricTimer	longRunningTimer(String name, MetricTag.RequiredMetricTag... tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static LongRunningMetricTimer	longRunningTimer(String name, Collection<MetricTag.RequiredMetricTag> tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static Metrics.Builder	metric(String name)	Start creating a metric using the Metrics.Builder
static void	resetMetric(MetricKey metricKey)	Resets (that may mean removal depending on the metric strategy) a specific metric that exactly matches a MetricKey.
static Ticker	startLongRunningTimer(String name)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static Ticker	startLongRunningTimer(String name, MetricTag.RequiredMetricTag... tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static Ticker	startLongRunningTimer(String name, Collection<MetricTag.RequiredMetricTag> tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static Ticker	startTimer(String name)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static Ticker	startTimer(String name, MetricTag.RequiredMetricTag... tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static Ticker	startTimer(String name, Collection<MetricTag.RequiredMetricTag> tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static MetricTimer	timer(String name)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static MetricTimer	timer(String name, MetricTag.RequiredMetricTag... tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.
static MetricTimer	timer(String name, Collection<MetricTag.RequiredMetricTag> tags)	Deprecated. since 4.3.0, for removal in 5.0.0, use the metric(String) builder instead.

Methods inherited from class java.lang.Object

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

Method Details

resetMetric

public static void resetMetric(MetricKey metricKey)

Resets (that may mean removal depending on the metric strategy) a specific metric that exactly matches a MetricKey.

Parameters:

metricKey - metric key to be reset.

Since:

4.9.0

getConfiguration

@Nonnull
public static MetricsConfiguration getConfiguration()

Get the current MetricsConfiguration.

Returns:

the current configuration.

Since:

3.0.0

histogram

@Deprecated
@Nonnull
public static Histogram histogram(String name)

Deprecated.

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

Creates a Histogram with the given name.

Returns:

the created Histogram

Since:

3.4.0

histogram

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

Deprecated.

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

Creates a Histogram with the given name, and tags it with the given tags.

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

Returns:

the created Histogram

Since:

3.4.0

histogram

@Deprecated
@Nonnull
public static Histogram histogram(String name,
 MetricTag.RequiredMetricTag... tags)

Deprecated.

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

Creates a Histogram with the given name, and tags it with the given tags.

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

Returns:

the created Histogram

Since:

3.4.0

timer

@Deprecated
@Nonnull
public static MetricTimer timer(String name)

Deprecated.

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

Creates a MetricTimer with the given name.

Returns:

the created MetricTimer

Since:

3.4.0

timer

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

Deprecated.

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

Creates a MetricTimer with the given name, and tags it with the given tags.

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

Returns:

the created MetricTimer

Since:

3.4.0

timer

@Deprecated
@Nonnull
public static MetricTimer timer(String name,
 MetricTag.RequiredMetricTag... tags)

Deprecated.

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

Creates a MetricTimer with the given name, and tags it with the given tags.

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

Returns:

the created MetricTimer

Since:

3.4.0

longRunningTimer

@Deprecated
@Nonnull
public static LongRunningMetricTimer longRunningTimer(String name)

Deprecated.

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

Creates a LongRunningMetricTimer with the given name.

Returns:

the created LongRunningMetricTimer

Since:

3.5.0

longRunningTimer

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

Deprecated.

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

Creates a LongRunningMetricTimer with the given name, and tags it with the given tags.

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

Returns:

the created LongRunningMetricTimer

Since:

3.5.0

longRunningTimer

@Deprecated
@Nonnull
public static LongRunningMetricTimer longRunningTimer(String name,
 MetricTag.RequiredMetricTag... tags)

Deprecated.

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

Creates a LongRunningMetricTimer with the given name, and tags it with the given tags.

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

Returns:

the created LongRunningMetricTimer

Since:

3.5.0

startTimer

@Deprecated
@Nonnull
public static Ticker startTimer(String name)

Deprecated.

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

Starts a MetricTimer with the given name.

Returns:

a Ticker to stop the created and started MetricTimer

Since:

3.4.0

startTimer

@Deprecated
@Nonnull
public static Ticker startTimer(String name,
 MetricTag.RequiredMetricTag... tags)

Deprecated.

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

Starts a MetricTimer with the given name, and tags it with the given tags.

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

Returns:

a Ticker to stop the created and started MetricTimer

Since:

3.4.0

startTimer

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

Deprecated.

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

Starts a MetricTimer with the given name, and tags it with the given tags.

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

Returns:

a Ticker to stop the created and started MetricTimer

Since:

3.4.0

startLongRunningTimer

@Deprecated
@Nonnull
public static Ticker startLongRunningTimer(String name)

Deprecated.

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

Starts a LongRunningMetricTimer with the given name, and tags it with the given tags.

Returns:

a Ticker to stop the created and started LongRunningMetricTimer

Since:

3.5.0

startLongRunningTimer

@Deprecated
@Nonnull
public static Ticker startLongRunningTimer(String name,
 MetricTag.RequiredMetricTag... tags)

Deprecated.

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

Starts a LongRunningMetricTimer with the given name, and tags it with the given tags.

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

Returns:

a Ticker to stop the created and started LongRunningMetricTimer

Since:

3.5.0

startLongRunningTimer

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

Deprecated.

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

Starts a LongRunningMetricTimer with the given name, and tags it with the given tags.

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

Returns:

a Ticker to stop the created and started LongRunningMetricTimer

Since:

3.5.0

metric

public static Metrics.Builder metric(String name)

Start creating a metric using the Metrics.Builder

Parameters:

name - metric name

Returns:

a metric builder

Since:

3.5.0