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

Class ClusterAwareMetrics

java.lang.Object

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

public class ClusterAwareMetrics
extends Object

Collect certain performance metrics for ClusterAwareConnectionProxy.

Performance (duration in time) metrics: - Failover Detection Duration of time between a start of executing sql statement to the moment when driver identifies a communication error and starts a failover process (a process to re-connect to another cluster instance). - Writer Failover Procedure records the duration of time running writer failover procedure. - Reader Failover Procedure records the duration of time running reader failover procedure. - Topology Query records the duration of time it takes to fetch the new topology

Performance (hit-miss) metrics: - Successful Failover Reconnects A total number of failover events vs a number of successful ones. "Hit" events record whenever a failover procedure successfully reconnects to an appropriate instance and "Miss" events record whenever a failover procedure fails to reconenct to an appropriate instance.

Constructor Summary

Constructors

Constructor and Description
ClusterAwareMetrics() Constructor for ClusterAwareMetrics.

Method Summary

Modifier and Type	Method and Description
void	registerFailoverConnects(boolean isHit) Registers whether or not a failover procedure successfully reconnected
void	registerFailureDetectionTime(long timeMs) Registers the time it takes to failover
void	registerReaderFailoverProcedureTime(long timeMs) Registers the time it takes to perform a reader failover once initiated
void	registerTopologyQueryTime(long timeMs) Registers the time it takes to fetch the topology from the database
void	registerWriterFailoverProcedureTime(long timeMs) Registers the time it takes to perform a writer failover once initiated
void	reportMetrics(Logger log) Create a report from the current available data and attach it to a Logger instance

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterAwareMetrics

public ClusterAwareMetrics()

Constructor for ClusterAwareMetrics. Creates a list of all metrics that will be recorded.

Method Detail

registerFailureDetectionTime

public void registerFailureDetectionTime(long timeMs)

Registers the time it takes to failover

Parameters:

timeMs - Time it took to detect that failover is needed

registerWriterFailoverProcedureTime

public void registerWriterFailoverProcedureTime(long timeMs)

Registers the time it takes to perform a writer failover once initiated

Parameters:

timeMs - Time it took for writer to failover

registerReaderFailoverProcedureTime

public void registerReaderFailoverProcedureTime(long timeMs)

Registers the time it takes to perform a reader failover once initiated

Parameters:

timeMs - Time it took for reader to failover

registerTopologyQueryTime

public void registerTopologyQueryTime(long timeMs)

Registers the time it takes to fetch the topology from the database

Parameters:

timeMs - Time it to took to complete the topology query

registerFailoverConnects

public void registerFailoverConnects(boolean isHit)

Registers whether or not a failover procedure successfully reconnected

Parameters:

isHit - True if failover was successful

reportMetrics

public void reportMetrics(Logger log)

Create a report from the current available data and attach it to a Logger instance

Parameters:

log - the log used to display