com.hazelcast.internal.metrics.impl

Class ProbeBuilderImpl

java.lang.Object

com.hazelcast.internal.metrics.impl.ProbeBuilderImpl

All Implemented Interfaces:

ProbeBuilder

public class ProbeBuilderImpl
extends Object
implements ProbeBuilder

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> probe) Registers a single probe.
<S> void	register(S source, String metricName, ProbeLevel level, ProbeUnit unit, LongProbeFunction<S> probe) 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.
ProbeBuilderImpl	withTag(String tag, String value) Returns a new ProbeBuilder instance with the given tag added.

Methods inherited from class java.lang.Object

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

Method Detail

withTag

@CheckReturnValue
public ProbeBuilderImpl withTag(String tag,
                                                  String value)

Description copied from interface: ProbeBuilder

Returns a new ProbeBuilder instance with the given tag added.

Specified by:

withTag in interface ProbeBuilder

metricName

public String metricName()

Description copied from interface: ProbeBuilder

Returns the name for the metric.

Specified by:

metricName in interface ProbeBuilder

register

public <S> void register(@Nonnull
                         S source,
                         @Nonnull
                         String metricName,
                         @Nonnull
                         ProbeLevel level,
                         @Nonnull
                         ProbeUnit unit,
                         @Nonnull
                         DoubleProbeFunction<S> probe)

Description copied from interface: ProbeBuilder

Registers a single probe.

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

Specified by:

register in interface ProbeBuilder

Parameters:

source - the object to pass to probeFn

metricName - the value of "metric" tag

level - the ProbeLevel

unit - the unit

probe - the probe function

register

public <S> void register(@Nonnull
                         S source,
                         @Nonnull
                         String metricName,
                         @Nonnull
                         ProbeLevel level,
                         @Nonnull
                         ProbeUnit unit,
                         @Nonnull
                         LongProbeFunction<S> probe)

Description copied from interface: ProbeBuilder

Registers a single probe.

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

Specified by:

register in interface ProbeBuilder

Parameters:

source - the object to pass to probeFn

metricName - the value of "metric" tag

level - the ProbeLevel

unit - the unit

probe - the probe function

scanAndRegister

public <S> void scanAndRegister(S source)

Description copied from interface: ProbeBuilder

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.

Specified by:

scanAndRegister in interface ProbeBuilder

Parameters:

source - the object to scan