com.atlassian.util.profiling.strategy

Interface MetricStrategy

public interface MetricStrategy

Strategy for tracking metrics of profiled code blocks, to be used with Metrics.

Only metric timers and histograms created through Metrics.timer(String), Metrics.startTimer(String), Metrics.histogram(String), Timers.timerWithMetric(java.lang.String, java.lang.String) and Timers.startWithMetric(java.lang.String) will interact with configured MetricStrategy instances.

Since:

3.0

See Also:

Metrics, Timers

Method Summary

Modifier and Type	Method and Description
default void	onRequestEnd() Method that is called to signal that the request has completed.
void	setConfiguration(MetricsConfiguration configuration) Method that is called when the strategy is registered.
Ticker	startTimer(String metricName) Called to mark the end of a block of code for which metrics should be calculated.
void	updateHistogram(String metricName, long value) Called when a histogram is updated.
void	updateTimer(String metricName, long time, TimeUnit timeUnit) Called when a metric is updated.

Method Detail

onRequestEnd

default void onRequestEnd()

Method that is called to signal that the request has completed. Implementations of this method should clean up any request or thread scoped resources associated with profiling state, including closing any tickers that have not yet been closed.

setConfiguration

void setConfiguration(@Nonnull
                      MetricsConfiguration configuration)

Method that is called when the strategy is registered.

Parameters:

configuration - the configuration

startTimer

@Nonnull
Ticker startTimer(@Nonnull
                           String metricName)

Called to mark the end of a block of code for which metrics should be calculated.

Parameters:

metricName - the name of metric

Returns:

a ticker that can be used to mark the end of the code block for which metrics should be calculated. Must be non-null, but can be Ticker.NO_OP if the strategy opts out of tracking.

updateHistogram

void updateHistogram(@Nonnull
                     String metricName,
                     long value)

Called when a histogram is updated.

Parameters:

metricName - the histogram name

value - the value to record

updateTimer

void updateTimer(@Nonnull
                 String metricName,
                 long time,
                 @Nonnull
                 TimeUnit timeUnit)

Called when a metric is updated.

Parameters:

metricName - the name of metric

time - the time to record

timeUnit - the time unit of time