software.aws.rds.jdbc.postgresql.ca.metrics

Class ClusterAwareHitMissMetricsHolder

java.lang.Object

software.aws.rds.jdbc.postgresql.ca.metrics.ClusterAwareHitMissMetricsHolder

All Implemented Interfaces:

ClusterAwareMetricsReporter<Boolean>

public class ClusterAwareHitMissMetricsHolder
extends Object
implements ClusterAwareMetricsReporter<Boolean>

A simple implementation of hit-miss metric. It collects a total number of events been reported as well as number of "hit" events.

Example of hit-miss metric: loaded or not loaded data, data found in cache or not found.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	metricName
protected int	numberOfHits
protected int	numberOfReports

Constructor Summary

Constructors

Constructor and Description
ClusterAwareHitMissMetricsHolder(String metricName) Initialize a metric holder with a metric name.

Method Summary

Modifier and Type	Method and Description
void	register(Boolean isHit) Register (notify) a metric holder about event.
void	reportMetrics(Logger log) Report collected metric to a provided logger.

Methods inherited from class java.lang.Object

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

Field Detail

metricName

protected String metricName

numberOfReports

protected int numberOfReports

numberOfHits

protected int numberOfHits

Constructor Detail

ClusterAwareHitMissMetricsHolder

public ClusterAwareHitMissMetricsHolder(String metricName)

Initialize a metric holder with a metric name.

Parameters:

metricName - Metric name

Method Detail

register

public void register(Boolean isHit)

Register (notify) a metric holder about event.

Specified by:

register in interface ClusterAwareMetricsReporter<Boolean>

Parameters:

isHit - True if event is a "hit" event.

reportMetrics

public void reportMetrics(Logger log)

Report collected metric to a provided logger.

Specified by:

reportMetrics in interface ClusterAwareMetricsReporter<Boolean>

Parameters:

log - A logger to report collected metric.