org.apache.flink.metrics.groups

Interface CacheMetricGroup

All Superinterfaces:

MetricGroup

All Known Implementing Classes:

InternalCacheMetricGroup

@PublicEvolving
public interface CacheMetricGroup
extends MetricGroup

Pre-defined metrics for cache.

Please note that these methods should only be invoked once. Registering a metric with same name for multiple times would lead to an undefined behavior.

Method Summary

Modifier and Type	Method and Description
void	hitCounter(Counter hitCounter) The number of cache hits.
void	latestLoadTimeGauge(Gauge<Long> latestLoadTimeGauge) The time spent for the latest load operation.
void	loadCounter(Counter loadCounter) The number of times to load data into cache from external system.
void	missCounter(Counter missCounter) The number of cache misses.
void	numCachedBytesGauge(Gauge<Long> numCachedBytesGauge) The number of bytes used by cache.
void	numCachedRecordsGauge(Gauge<Long> numCachedRecordsGauge) The number of records in cache.
void	numLoadFailuresCounter(Counter numLoadFailuresCounter) The number of load failures.

Methods inherited from interface org.apache.flink.metrics.MetricGroup

addGroup, addGroup, addGroup, addSpan, counter, counter, counter, counter, gauge, gauge, getAllVariables, getMetricIdentifier, getMetricIdentifier, getScopeComponents, histogram, histogram, meter, meter

Method Detail

hitCounter

void hitCounter(Counter hitCounter)

The number of cache hits.

missCounter

void missCounter(Counter missCounter)

The number of cache misses.

loadCounter

void loadCounter(Counter loadCounter)

The number of times to load data into cache from external system.

numLoadFailuresCounter

void numLoadFailuresCounter(Counter numLoadFailuresCounter)

The number of load failures.

latestLoadTimeGauge

void latestLoadTimeGauge(Gauge<Long> latestLoadTimeGauge)

The time spent for the latest load operation.

numCachedRecordsGauge

void numCachedRecordsGauge(Gauge<Long> numCachedRecordsGauge)

The number of records in cache.

numCachedBytesGauge

void numCachedBytesGauge(Gauge<Long> numCachedBytesGauge)

The number of bytes used by cache.