org.corfudb.util

Class MetricsUtils

java.lang.Object

org.corfudb.util.MetricsUtils

public class MetricsUtils
extends Object

Method Summary

Modifier and Type	Method and Description
static void	addCacheMeasurerFor(com.codahale.metrics.MetricRegistry metrics, com.github.benmanes.caffeine.cache.Cache cache) This method adds different properties of provided instance of Cache to the indicated metrics registry.
static com.codahale.metrics.Gauge<Long>	addMemoryMeasurerFor(com.codahale.metrics.MetricRegistry metrics, Object object) This method creates object size gauge and registers it to the metrics registry.
static com.codahale.metrics.Timer.Context	getConditionalContext(boolean enabled, com.codahale.metrics.Timer t)
static com.codahale.metrics.Timer.Context	getConditionalContext(com.codahale.metrics.Timer t)
static void	incConditionalCounter(boolean enabled, com.codahale.metrics.Counter counter, long amount)
static boolean	isMetricsReportingSetUp(com.codahale.metrics.MetricRegistry metrics) Check whether the metrics reporting has been already set up using metricsReportingSetup.
static void	metricsReportingSetup(com.codahale.metrics.MetricRegistry metrics) Start metrics reporting via the Dropwizard 'CsvReporter', 'JmxReporter', and 'Slf4jReporter'.
static void	stopConditionalContext(com.codahale.metrics.Timer.Context context)

Methods inherited from class java.lang.Object

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

Method Detail

isMetricsReportingSetUp

public static boolean isMetricsReportingSetUp(@NonNull
                                              com.codahale.metrics.MetricRegistry metrics)

Check whether the metrics reporting has been already set up using metricsReportingSetup.

Parameters:

metrics - Metric Registry

Returns:

a boolean representing whether metrics reporting has been already set up. earlier

metricsReportingSetup

public static void metricsReportingSetup(@NonNull
                                         com.codahale.metrics.MetricRegistry metrics)

Start metrics reporting via the Dropwizard 'CsvReporter', 'JmxReporter', and 'Slf4jReporter'. Reporting can be turned on and off via the system properties described in loadVmProperties()'s docs. The report interval and report directory cannot be altered at runtime.

Parameters:

metrics - Metrics registry

getConditionalContext

public static com.codahale.metrics.Timer.Context getConditionalContext(@NonNull
                                                                       com.codahale.metrics.Timer t)

getConditionalContext

public static com.codahale.metrics.Timer.Context getConditionalContext(boolean enabled,
                                                                       @NonNull
                                                                       com.codahale.metrics.Timer t)

stopConditionalContext

public static void stopConditionalContext(com.codahale.metrics.Timer.Context context)

incConditionalCounter

public static void incConditionalCounter(boolean enabled,
                                         @NonNull
                                         com.codahale.metrics.Counter counter,
                                         long amount)

addMemoryMeasurerFor

public static com.codahale.metrics.Gauge<Long> addMemoryMeasurerFor(@NonNull
                                                                    com.codahale.metrics.MetricRegistry metrics,
                                                                    Object object)

This method creates object size gauge and registers it to the metrics registry. The method guarantees that no strong reference to the provided object will be retained. Hence it does not prevent garbage collection if the client does not hold a strong reference to the object being measured.

Parameters:

metrics - the metrics registry to which the size gauge will be registered.

object - the object which its size will be measured with a corresponding gauge*

Returns:

a gauge that provides an estimate of deep size for the provided object as long as there exist a strong reference to that object.

addCacheMeasurerFor

public static void addCacheMeasurerFor(@NonNull
                                       com.codahale.metrics.MetricRegistry metrics,
                                       com.github.benmanes.caffeine.cache.Cache cache)

This method adds different properties of provided instance of Cache to the indicated metrics registry. The added properties of cache are: cache.object-counts: estimated size of cache. cache.evictions : number of cache evictions cache.hit-rate : hit rate of cache. cache.hits : cache.misses :

Parameters:

metrics -

cache -