Package 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 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.