Package io.pravega.shared.metrics

Interface MetricNotifier

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

ClientMetricUpdater

public interface MetricNotifier
extends java.lang.AutoCloseable

A notifier that is used to notify metrics to the user specified MetricListener.

Field Summary

Fields

Modifier and Type	Field	Description
static MetricNotifier	NO_OP_METRIC_NOTIFIER

Method Summary

Modifier and Type	Method	Description
void	close()
void	updateFailureMetric(ClientMetricKeys metricKey, java.lang.String[] metricTags, long value)	Notify a failure metric to the user specified MetricListener.
void	updateSuccessMetric(ClientMetricKeys metricKey, java.lang.String[] metricTags, long value)	Notify a success metric to the user specified MetricListener.

Field Detail

NO_OP_METRIC_NOTIFIER

static final MetricNotifier NO_OP_METRIC_NOTIFIER

Method Detail

updateSuccessMetric

void updateSuccessMetric(ClientMetricKeys metricKey,
                         java.lang.String[] metricTags,
                         long value)

Notify a success metric to the user specified MetricListener.

Parameters:

metricKey - The metric key.

metricTags - Tags associated with the metric.

value - Value of the metric observed.

updateFailureMetric

void updateFailureMetric(ClientMetricKeys metricKey,
                         java.lang.String[] metricTags,
                         long value)

Notify a failure metric to the user specified MetricListener.

Parameters:

metricKey - The metric key.

metricTags - Tags associated with the metric.

value - Value of the metric observed.

close

void close()

Specified by:

close in interface java.lang.AutoCloseable