org.ballerinalang.util.metrics

Class CallbackGauge.Builder<T>

java.lang.Object

org.ballerinalang.util.metrics.CallbackGauge.Builder<T>

Type Parameters:

T - The type of the state object from which the gauge value is extracted.

All Implemented Interfaces:

Metric.Builder<CallbackGauge.Builder<T>,CallbackGauge>

Enclosing interface:

CallbackGauge

public static class CallbackGauge.Builder<T>
extends Object
implements Metric.Builder<CallbackGauge.Builder<T>,CallbackGauge>

Builder for CallbackGauges.

Method Summary

Modifier and Type	Method and Description
CallbackGauge.Builder<T>	description(String description) Set the description of the metric.
CallbackGauge	register() Create and register the metric with the default registry.
CallbackGauge	register(MetricRegistry registry) Create and register the metric with the given registry.
CallbackGauge.Builder	tag(String key, String value) Add tags to this metric.
CallbackGauge.Builder	tags(Iterable<Tag> tags) Add tags to this metric.
CallbackGauge.Builder	tags(Map<String,String> tags) Add tags to this metric.
CallbackGauge.Builder	tags(String... keyValues) Add tags to this metric.

Methods inherited from class java.lang.Object

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

Method Detail

description

public CallbackGauge.Builder<T> description(String description)

Description copied from interface: Metric.Builder

Set the description of the metric.

Specified by:

description in interface Metric.Builder<CallbackGauge.Builder<T>,CallbackGauge>

Parameters:

description - The description of the metric.

Returns:

This builder instance.

tags

public CallbackGauge.Builder tags(String... keyValues)

Description copied from interface: Metric.Builder

Add tags to this metric.

Specified by:

tags in interface Metric.Builder<CallbackGauge.Builder<T>,CallbackGauge>

Parameters:

keyValues - Must be an even number of arguments representing key/value pairs of tags.

Returns:

The builder with added tags.

tags

public CallbackGauge.Builder tags(Iterable<Tag> tags)

Description copied from interface: Metric.Builder

Add tags to this metric.

Specified by:

tags in interface Metric.Builder<CallbackGauge.Builder<T>,CallbackGauge>

Parameters:

tags - Tags to add to the metrics

Returns:

The builder with added tags.

tag

public CallbackGauge.Builder tag(String key,
                                 String value)

Description copied from interface: Metric.Builder

Add tags to this metric.

Specified by:

tag in interface Metric.Builder<CallbackGauge.Builder<T>,CallbackGauge>

Parameters:

key - The tag key.

value - The tag value.

Returns:

The builder with a single added tag.

tags

public CallbackGauge.Builder tags(Map<String,String> tags)

Description copied from interface: Metric.Builder

Add tags to this metric.

Specified by:

tags in interface Metric.Builder<CallbackGauge.Builder<T>,CallbackGauge>

Parameters:

tags - A map of key value pairs to be used as tags

Returns:

The builder with added tags.

register

public CallbackGauge register()

Description copied from interface: Metric.Builder

Create and register the metric with the default registry.

Specified by:

register in interface Metric.Builder<CallbackGauge.Builder<T>,CallbackGauge>

Returns:

Registered metric

register

public CallbackGauge register(MetricRegistry registry)

Description copied from interface: Metric.Builder

Create and register the metric with the given registry.

Specified by:

register in interface Metric.Builder<CallbackGauge.Builder<T>,CallbackGauge>

Parameters:

registry - MetricRegistry to be used

Returns:

Registered metric