software.amazon.jdbc.plugin.cache

Class CacheMonitor

java.lang.Object

software.amazon.jdbc.util.monitoring.AbstractMonitor

software.amazon.jdbc.plugin.cache.CacheMonitor

All Implemented Interfaces:

java.lang.Runnable, Monitor

public class CacheMonitor
extends AbstractMonitor

This class uses a background thread to monitor cache cluster health and manage state transitions.

Implements a three-state machine (HEALTHY → SUSPECT → DEGRADED) with proactive health checks that only run when clusters are in SUSPECT or DEGRADED states.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CacheMonitor.ErrorCategory
protected static class	CacheMonitor.HealthState Enum representing the health state of a cache cluster or endpoint.

Field Summary

Fields

Modifier and Type	Field and Description
static AwsWrapperProperty	CACHE_HEALTH_CHECK_IN_HEALTHY_STATE
static AwsWrapperProperty	CACHE_IN_FLIGHT_WRITE_SIZE_LIMIT

Fields inherited from class software.amazon.jdbc.util.monitoring.AbstractMonitor

lastActivityTimestampNanos, monitorExecutor, state, stop, terminationTimeoutSec

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CacheMonitor(long inFlightWriteSizeLimitBytes, boolean healthCheckInHealthyState, TelemetryFactory telemetryFactory)

Method Summary

Modifier and Type	Method and Description
protected static void	decrementInFlightSizeStatic(java.lang.String rwEndpoint, java.lang.String roEndpoint, long bytes)
protected static CacheMonitor.HealthState	getClusterState(java.lang.String rwEndpoint, java.lang.String roEndpoint)
protected static void	incrementInFlightSizeStatic(java.lang.String rwEndpoint, java.lang.String roEndpoint, long bytes)
void	monitor() Executes the monitoring loop for this monitor.
protected static void	registerCluster(FullServicesContainer servicesContainer, long inFlightWriteSizeLimitBytes, boolean healthCheckInHealthyState, TelemetryFactory telemetryFactory, java.lang.String rwEndpoint, java.lang.String roEndpoint, boolean useSSL, java.time.Duration cacheConnectionTimeout, boolean iamAuthEnabled, java.lang.String cacheIamRegion, java.lang.String cacheName, java.lang.String cacheUsername, java.lang.String cachePassword)
protected static void	registerCluster(FullServicesContainer servicesContainer, long inFlightWriteSizeLimitBytes, boolean healthCheckInHealthyState, TelemetryFactory telemetryFactory, java.lang.String rwEndpoint, java.lang.String roEndpoint, boolean useSSL, java.time.Duration cacheConnectionTimeout, boolean iamAuthEnabled, java.lang.String cacheIamRegion, java.lang.String cacheName, java.lang.String cacheUsername, java.lang.String cachePassword, boolean createPingConnection, boolean startMonitorThread)
protected static void	reportError(java.lang.String rwEndpoint, java.lang.String roEndpoint, boolean isRw, java.lang.Throwable error, java.lang.String operation)
protected static void	resetInstance()
protected void	setPingConnections(software.amazon.jdbc.plugin.cache.CacheMonitor.ClusterHealthState cluster, CachePingConnection rwConnection, CachePingConnection roConnection)
protected void	sleep(long duration)

Methods inherited from class software.amazon.jdbc.util.monitoring.AbstractMonitor

canDispose, close, getLastActivityTimestampNanos, getState, run, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_IN_FLIGHT_WRITE_SIZE_LIMIT

public static final AwsWrapperProperty CACHE_IN_FLIGHT_WRITE_SIZE_LIMIT

CACHE_HEALTH_CHECK_IN_HEALTHY_STATE

public static final AwsWrapperProperty CACHE_HEALTH_CHECK_IN_HEALTHY_STATE

Constructor Detail

CacheMonitor

protected CacheMonitor(long inFlightWriteSizeLimitBytes,
                       boolean healthCheckInHealthyState,
                       TelemetryFactory telemetryFactory)

Method Detail

registerCluster

protected static void registerCluster(FullServicesContainer servicesContainer,
                                      long inFlightWriteSizeLimitBytes,
                                      boolean healthCheckInHealthyState,
                                      TelemetryFactory telemetryFactory,
                                      java.lang.String rwEndpoint,
                                      java.lang.String roEndpoint,
                                      boolean useSSL,
                                      java.time.Duration cacheConnectionTimeout,
                                      boolean iamAuthEnabled,
                                      java.lang.String cacheIamRegion,
                                      java.lang.String cacheName,
                                      java.lang.String cacheUsername,
                                      java.lang.String cachePassword,
                                      boolean createPingConnection,
                                      boolean startMonitorThread)

registerCluster

protected static void registerCluster(FullServicesContainer servicesContainer,
                                      long inFlightWriteSizeLimitBytes,
                                      boolean healthCheckInHealthyState,
                                      TelemetryFactory telemetryFactory,
                                      java.lang.String rwEndpoint,
                                      java.lang.String roEndpoint,
                                      boolean useSSL,
                                      java.time.Duration cacheConnectionTimeout,
                                      boolean iamAuthEnabled,
                                      java.lang.String cacheIamRegion,
                                      java.lang.String cacheName,
                                      java.lang.String cacheUsername,
                                      java.lang.String cachePassword)

setPingConnections

protected void setPingConnections(software.amazon.jdbc.plugin.cache.CacheMonitor.ClusterHealthState cluster,
                                  CachePingConnection rwConnection,
                                  CachePingConnection roConnection)

getClusterState

protected static CacheMonitor.HealthState getClusterState(java.lang.String rwEndpoint,
                                                          java.lang.String roEndpoint)

reportError

protected static void reportError(java.lang.String rwEndpoint,
                                  java.lang.String roEndpoint,
                                  boolean isRw,
                                  java.lang.Throwable error,
                                  java.lang.String operation)

incrementInFlightSizeStatic

protected static void incrementInFlightSizeStatic(java.lang.String rwEndpoint,
                                                  java.lang.String roEndpoint,
                                                  long bytes)

decrementInFlightSizeStatic

protected static void decrementInFlightSizeStatic(java.lang.String rwEndpoint,
                                                  java.lang.String roEndpoint,
                                                  long bytes)

monitor

public void monitor()
             throws java.lang.Exception

Description copied from interface: Monitor

Executes the monitoring loop for this monitor. This method should be called in the run() method of the thread submitted during the call to Monitor.start(). Additionally, the monitoring loop should regularly update the last activity timestamp so that the MonitorService can detect whether the monitor is stuck or not.

Throws:

java.lang.Exception - if there's an error executing the monitoring logic.

sleep

protected void sleep(long duration)
              throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

resetInstance

protected static void resetInstance()