com.hazelcast.internal.metrics

Interface ProbeBuilder

All Known Implementing Classes:

ProbeBuilderImpl

public interface ProbeBuilder

Immutable builder object to register Probes.

Method Summary

Modifier and Type	Method and Description
String	metricName() Returns the name for the metric.
<S> void	register(S source, String metricName, ProbeLevel level, ProbeUnit unit, DoubleProbeFunction<S> probeFn) Registers a single probe.
<S> void	register(S source, String metricName, ProbeLevel level, ProbeUnit unit, LongProbeFunction<S> probeFn) Registers a single probe.
<S> void	scanAndRegister(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.
ProbeBuilder	withTag(String tag, String value) Returns a new ProbeBuilder instance with the given tag added.

Method Detail

withTag

ProbeBuilder withTag(String tag,
                     String value)

Returns a new ProbeBuilder instance with the given tag added.

register

<S> void register(@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

register

<S> void register(@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

scanAndRegister

<S> void scanAndRegister(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.