T
- The type of the state object from which the gauge value is extracted.public static class PolledGauge.Builder<T> extends Object implements Metric.Builder<PolledGauge.Builder<T>,PolledGauge>
PolledGauge
s.Modifier and Type | Method and Description |
---|---|
PolledGauge |
build()
Build the metric without registering.
|
PolledGauge.Builder<T> |
description(String description)
Set the description of the metric.
|
PolledGauge |
register()
Create and register the metric with the default registry.
|
PolledGauge |
register(MetricRegistry registry)
Create and register the metric with the given registry.
|
PolledGauge.Builder |
tag(String key,
String value)
Add tags to this metric.
|
PolledGauge.Builder |
tags(Iterable<Tag> tags)
Add tags to this metric.
|
PolledGauge.Builder |
tags(Map<String,String> tags)
Add tags to this metric.
|
PolledGauge.Builder |
tags(String... keyValues)
Add tags to this metric.
|
public PolledGauge.Builder<T> description(String description)
Metric.Builder
description
in interface Metric.Builder<PolledGauge.Builder<T>,PolledGauge>
description
- The description of the metric.public PolledGauge.Builder tags(String... keyValues)
Metric.Builder
tags
in interface Metric.Builder<PolledGauge.Builder<T>,PolledGauge>
keyValues
- Must be an even number of arguments representing key/value pairs of tags.public PolledGauge.Builder tags(Iterable<Tag> tags)
Metric.Builder
tags
in interface Metric.Builder<PolledGauge.Builder<T>,PolledGauge>
tags
- Tags to add to the metricspublic PolledGauge.Builder tag(String key, String value)
Metric.Builder
tag
in interface Metric.Builder<PolledGauge.Builder<T>,PolledGauge>
key
- The tag key.value
- The tag value.public PolledGauge.Builder tags(Map<String,String> tags)
Metric.Builder
tags
in interface Metric.Builder<PolledGauge.Builder<T>,PolledGauge>
tags
- A map of key value pairs to be used as tagspublic PolledGauge register()
Metric.Builder
register
in interface Metric.Builder<PolledGauge.Builder<T>,PolledGauge>
public PolledGauge register(MetricRegistry registry)
Metric.Builder
register
in interface Metric.Builder<PolledGauge.Builder<T>,PolledGauge>
registry
- MetricRegistry
to be usedpublic PolledGauge build()
Metric.Builder
build
in interface Metric.Builder<PolledGauge.Builder<T>,PolledGauge>
Copyright © 2018 WSO2. All rights reserved.