org.ballerinalang.util.metrics

Interface Metric.Builder<B extends Metric.Builder<B,M>,M extends Metric>

Type Parameters:

B - Builder for a given metric class.

M - Metric class.

All Known Implementing Classes:

CallbackGauge.Builder, Counter.Builder, Gauge.Builder, Summary.Builder, Timer.Builder

Enclosing interface:

Metric

public static interface Metric.Builder<B extends Metric.Builder<B,M>,M extends Metric>

Builder for metrics.

Method Summary

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

Method Detail

description

B description(String description)

Set the description of the metric.

Parameters:

description - The description of the metric.

Returns:

This builder instance.

tags

B tags(String... keyValues)

Add tags to this metric.

Parameters:

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

Returns:

The builder with added tags.

tags

B tags(Iterable<Tag> tags)

Add tags to this metric.

Parameters:

tags - Tags to add to the metrics

Returns:

The builder with added tags.

tag

B tag(String key,
      String value)

Add tags to this metric.

Parameters:

key - The tag key.

value - The tag value.

Returns:

The builder with a single added tag.

tags

B tags(Map<String,String> tags)

Add tags to this metric.

Parameters:

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

Returns:

The builder with added tags.

register

M register()

Create and register the metric with the default registry.

Returns:

Registered metric

register

M register(MetricRegistry registry)

Create and register the metric with the given registry.

Parameters:

registry - MetricRegistry to be used

Returns:

Registered metric