com.hazelcast.internal.metrics

Interface Metric

All Known Subinterfaces:

Gauge

All Known Implementing Classes:

GaugeImpl

public interface Metric

Each metric is uniquely identified using a name. See getName(). A metric gets its content from Probes. An input can be one of the following:

1. a method with the Probe annotation
2. a field with the Probe annotation
3. a LongProbe function
4. a DoubleProbe function

If the Metric is obtained before it is registered, the Metric is without input. As soon as the registration happens, the input is set on the metric and the current information will be retrieved.

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Gets the name that identifies this metric.
void	render(StringBuilder sb) Renders the metric.

Method Detail

getName

String getName()

Gets the name that identifies this metric. The returned value will never change and never be null.

Returns:

the name of the metric.

render

void render(StringBuilder sb)

Renders the metric.

Parameters:

sb - the StringBuilder to write to.

Throws:

NullPointerException - if sb is null