com.hazelcast.internal.metrics

Interface MetricTagger

All Known Implementing Classes:

MetricTaggerImpl

public interface MetricTagger

Interface to be used for tagging a metric.

Method Summary

Modifier and Type	Method and Description
String	metricId() Returns the id for the metric.
String	metricName() Returns the name for the metric.
<S> void	registerStaticMetrics(S source) Scans the source object for any fields/methods that have been annotated with Probe annotation, and registers these fields/methods as probe instances.
<S> void	registerStaticProbe(S source, String metricName, ProbeLevel level, DoubleProbeFunction<S> probeFn) Registers a single probe.
<S> void	registerStaticProbe(S source, String metricName, ProbeLevel level, LongProbeFunction<S> probeFn) Registers a single probe.
<S> void	registerStaticProbe(S source, String metricName, ProbeLevel level, ProbeUnit unit, DoubleProbeFunction<S> probeFn) Registers a single probe.
<S> void	registerStaticProbe(S source, String metricName, ProbeLevel level, ProbeUnit unit, LongProbeFunction<S> probeFn) Registers a single probe.
MetricTagger	withIdTag(String tag, String value) Returns a new MetricTagger instance with the given identifier tag added.
MetricTagger	withMetricTag(String value) Returns a new MetricTagger instance with the given metric name tag added.
MetricTagger	withTag(String tag, String value) Returns a new MetricTagger instance with the given general purpose tag added.

Method Detail

withTag

MetricTagger withTag(String tag,
                     String value)

Returns a new MetricTagger instance with the given general purpose tag added.

Parameters:

tag - The name of the tag

value - The value of the tag

withIdTag

MetricTagger withIdTag(String tag,
                       String value)

Returns a new MetricTagger instance with the given identifier tag added. The identifier tag will be used by the MetricsRegistryImpl in the key of the tag as a discriminator if the metric built with this MetricTagger is a static metric.

Parameters:

tag - The name of the tag

value - The value of the tag

See Also:

metricId()

withMetricTag

MetricTagger withMetricTag(String value)

Returns a new MetricTagger instance with the given metric name tag added.

Parameters:

value - The value of the tag

registerStaticProbe

<S> void registerStaticProbe(@Nonnull
                             S source,
                             @Nonnull
                             String metricName,
                             @Nonnull
                             ProbeLevel level,
                             @Nonnull
                             ProbeUnit unit,
                             @Nonnull
                             DoubleProbeFunction<S> probeFn)

Registers a single probe.

If a probe for the given name exists, it will be overwritten silently.

Parameters:

source - the object to pass to probeFn

metricName - the value of "metric" tag

level - the ProbeLevel

unit - the unit

probeFn - the probe function

Throws:

NullPointerException - if any of the arguments is null

registerStaticProbe

<S> void registerStaticProbe(@Nonnull
                             S source,
                             @Nonnull
                             String metricName,
                             @Nonnull
                             ProbeLevel level,
                             @Nonnull
                             DoubleProbeFunction<S> probeFn)

Registers a single probe.

If a probe for the given name exists, it will be overwritten silently.

Parameters:

source - the object to pass to probeFn

metricName - the value of "metric" tag

level - the ProbeLevel

probeFn - the probe function

Throws:

NullPointerException - if any of the arguments is null

registerStaticProbe

<S> void registerStaticProbe(@Nonnull
                             S source,
                             @Nonnull
                             String metricName,
                             @Nonnull
                             ProbeLevel level,
                             @Nonnull
                             ProbeUnit unit,
                             @Nonnull
                             LongProbeFunction<S> probeFn)

Registers a single probe.

If a probe for the given name exists, it will be overwritten silently.

Parameters:

source - the object to pass to probeFn

metricName - the value of "metric" tag

level - the ProbeLevel

unit - the unit

probeFn - the probe function

Throws:

NullPointerException - if any of the arguments is null

registerStaticProbe

<S> void registerStaticProbe(@Nonnull
                             S source,
                             @Nonnull
                             String metricName,
                             @Nonnull
                             ProbeLevel level,
                             @Nonnull
                             LongProbeFunction<S> probeFn)

Registers a single probe.

If a probe for the given name exists, it will be overwritten silently.

Parameters:

source - the object to pass to probeFn

metricName - the value of "metric" tag

level - the ProbeLevel

probeFn - the probe function

Throws:

NullPointerException - if any of the arguments is null

registerStaticMetrics

<S> void registerStaticMetrics(S source)

Scans the source object for any fields/methods that have been annotated with Probe annotation, and registers these fields/methods as probe instances.

If a probe with the same name already exists, the probe is overwritten silently.

If an object has no @Probe annotations, the call is ignored.

Parameters:

source - the object to scan

Throws:

IllegalArgumentException - if the source contains Probe annotation on a field/method of unsupported type.

metricName

String metricName()

Returns the name for the metric. It is used by the MetricsCollectors and MetricsPublishers. The returned format is like [name=myMap,unit=count,metric=map.entryCount].

metricId

String metricId()

Returns the id for the metric. Used in MetricsRegistryImpl as the key of the static metric built with this MetricTagger. The returned format is map[myMap].entryCount.

The purpose of the metricId is to make creating Gauges easier and less error prone. With the metricName(), changing the order of the tags, adding/removing tags break existing gauges.