com.atlassian.util.profiling

Class Metrics.Builder

java.lang.Object

com.atlassian.util.profiling.Metrics.Builder

Enclosing class:

Metrics

@ParametersAreNonnullByDefault
public static class Metrics.Builder
extends Object

A metric builder, to get started call Metrics.metric(String).

Since:

3.5.0

Method Summary

Modifier and Type	Method and Description
Metrics.Builder	collect(Iterable<String> metricTagKeys) Collects MetricTag.OptionalMetricTag that may exist in a MetricTagContext
Metrics.Builder	collect(String... metricTagKeys) Collects MetricTag.OptionalMetricTag that may exist in a MetricTagContext
Metrics.Builder	fromPluginKey(String pluginKey) Attribute a plugin for providing a module that is measured
Histogram	histogram() Creates a Histogram with information in the builder.
void	incrementCounter(Long deltaValue) Does not guarantee safety from lost-updates, check implementations.
void	incrementGauge(Long deltaValue) Does not guarantee safety from lost-updates, check implementations.
Metrics.Builder	invokerPluginKey(String pluginKey) Attribute the plugin for invoking measured code
LongRunningMetricTimer	longRunningTimer() Creates a LongRunningMetricTimer with information in the builder.
Metrics.Builder	optionalTag(String key, boolean value) Adds an optional tag to the metric.
Metrics.Builder	optionalTag(String key, int value) Adds an optional tag to the metric.
Metrics.Builder	optionalTag(String key, String value) Adds an optional tag to the metric.
Metrics.Builder	optionalTags(Iterable<MetricTag.OptionalMetricTag> optionalMetricTags) Adds optional tags to the metric.
Metrics.Builder	optionalTags(MetricTag.OptionalMetricTag... optionalMetricTags) Adds optional tags to the metric.
void	setGauge(Long currentValue) Called to set the gauge by the value
Ticker	startLongRunningTimer() Starts a LongRunningMetricTimer with information in the builder.
Ticker	startTimer() Starts a MetricTimer with information in the builder.
Metrics.Builder	tag(String key, boolean value) Adds a tag to the metric.
Metrics.Builder	tag(String key, int value) Adds a tag to the metric.
Metrics.Builder	tag(String key, String value) Adds a tag to the metric.
Metrics.Builder	tags(Iterable<MetricTag.RequiredMetricTag> requiredMetricTags) Adds tags to the metric.
Metrics.Builder	tags(MetricTag.RequiredMetricTag... tags) Adds tags to the metric.
MetricTimer	timer() Creates a MetricTimer with information in the builder.
Metrics.Builder	withAnalytics() Mark any created metrics to be sent to analytics.
Metrics.Builder	withInvokerPluginKey() Attribute the plugin at the top of the call stack for invoking measured code

Methods inherited from class java.lang.Object

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

Method Detail

collect

@Nonnull
public Metrics.Builder collect(String... metricTagKeys)

Collects MetricTag.OptionalMetricTag that may exist in a MetricTagContext

Since:

4.0.0

collect

@Nonnull
public Metrics.Builder collect(Iterable<String> metricTagKeys)

Collects MetricTag.OptionalMetricTag that may exist in a MetricTagContext

Since:

4.0.0

tag

@Nonnull
public Metrics.Builder tag(String key,
                                    boolean value)

Adds a tag to the metric.

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

Since:

4.4.0

tag

@Nonnull
public Metrics.Builder tag(String key,
                                    int value)

Adds a tag to the metric.

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

Since:

4.4.0

tag

@Nonnull
public Metrics.Builder tag(String key,
                                    @Nullable
                                    String value)

Adds a tag to the metric.

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

Since:

3.5.0

tags

@Nonnull
public Metrics.Builder tags(MetricTag.RequiredMetricTag... tags)

Adds tags to the metric.

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

Since:

3.5.0

tags

@Nonnull
public Metrics.Builder tags(Iterable<MetricTag.RequiredMetricTag> requiredMetricTags)

Adds tags to the metric.

Note: If there is an existing tag with the same key, the new value will replace the old.

Note: If multiple tags with the same key are passed, the last one will win.

Note: There is no guarantee in the order of tags in the output, that is the responsibility of each MetricStrategy strategy used.

Since:

3.5.0

optionalTag

@Nonnull
public Metrics.Builder optionalTag(String key,
                                            boolean value)

Adds an optional tag to the metric.

See optionalTags(Iterable) for more information about optional tag behaviour.

Since:

4.4.0

optionalTag

@Nonnull
public Metrics.Builder optionalTag(String key,
                                            int value)

Adds an optional tag to the metric.

See optionalTags(Iterable) for more information about optional tag behaviour.

Since:

4.4.0

optionalTag

@Nonnull
public Metrics.Builder optionalTag(String key,
                                            @Nullable
                                            String value)

Adds an optional tag to the metric.

See optionalTags(Iterable) for more information about optional tag behaviour.

Since:

4.0.0

optionalTags

@Nonnull
public Metrics.Builder optionalTags(MetricTag.OptionalMetricTag... optionalMetricTags)

Adds optional tags to the metric.

See optionalTags(Iterable) for more information about optional tag behaviour.

Since:

4.0.0

optionalTags

@Nonnull
public Metrics.Builder optionalTags(Iterable<MetricTag.OptionalMetricTag> optionalMetricTags)

Adds optional tags to the metric.

Note: If there is an existing MetricTag.OptionalMetricTag with the same key, the new value will replace the old.

Note: If there is a MetricTag.RequiredMetricTag with the same key it will win, regardless of order.

Note: If there is an MetricTag.OptionalMetricTag with same key in a MetricTagContext then those provided to the builder will take priority

Note: There is no guarantee in the order of tags in the output, that is the responsibility of each MetricStrategy strategy used.

Since:

4.0.0

fromPluginKey

@Nonnull
public Metrics.Builder fromPluginKey(@Nullable
                                              String pluginKey)

Attribute a plugin for providing a module that is measured

Since:

3.6.0

invokerPluginKey

@Nonnull
public Metrics.Builder invokerPluginKey(@Nullable
                                                 String pluginKey)

Attribute the plugin for invoking measured code

Since:

3.6.0

withInvokerPluginKey

@Nonnull
public Metrics.Builder withInvokerPluginKey()

Attribute the plugin at the top of the call stack for invoking measured code

No guarantee, that the call stack will be able to be traversed, i.e if work is delegated to another thread.

Since:

3.6.0

withAnalytics

@Nonnull
public Metrics.Builder withAnalytics()

Mark any created metrics to be sent to analytics.

Reminder: add any tags to the appropriate analytics allow-list.

Since:

3.5.0

histogram

@Nonnull
public Histogram histogram()

Creates a Histogram with information in the builder.

Returns:

the created Histogram

Since:

3.5.0

incrementCounter

public void incrementCounter(@Nullable
                             Long deltaValue)

Does not guarantee safety from lost-updates, check implementations.

Called to increment to count the number of occurrences with information in the builder. The delta, must be positive.

Parameters:

deltaValue - the change in gauge that should be recorded

Since:

3.7.0

incrementGauge

public void incrementGauge(@Nullable
                           Long deltaValue)

Does not guarantee safety from lost-updates, check implementations.

Called to increment the gauge by the value. Starts from 0

Since:

4.8.0

setGauge

public void setGauge(@Nullable
                     Long currentValue)

Called to set the gauge by the value

Since:

4.8.0

timer

@Nonnull
public MetricTimer timer()

Creates a MetricTimer with information in the builder.

Returns:

the created MetricTimer

Since:

3.5.0

longRunningTimer

@Nonnull
public LongRunningMetricTimer longRunningTimer()

Creates a LongRunningMetricTimer with information in the builder.

Returns:

the created LongRunningMetricTimer

Since:

3.6.0

startTimer

@Nonnull
public Ticker startTimer()

Starts a MetricTimer with information in the builder.

Returns:

a Ticker to stop the created and started MetricTimer

Since:

3.5.0

startLongRunningTimer

@Nonnull
public Ticker startLongRunningTimer()

Starts a LongRunningMetricTimer with information in the builder.

Returns:

a Ticker to stop the created and started LongRunningMetricTimer

Since:

3.6.0