software.amazon.jdbc.plugin.efm.v2

Class HostMonitorV2Impl

java.lang.Object

software.amazon.jdbc.util.monitoring.AbstractMonitor

software.amazon.jdbc.plugin.efm.v2.HostMonitorV2Impl

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Runnable, HostMonitor, EventSubscriber, Monitor, StateSnapshotProvider

public class HostMonitorV2Impl
extends AbstractMonitor
implements HostMonitor, StateSnapshotProvider

This class uses a background thread to monitor a particular server with one or more active Connection.

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable TelemetryCounter	abortedConnectionsCounter
protected java.util.concurrent.Executor	abortExecutor
protected HostSpec	hostSpec
protected AtomicConnection	monitoringConn
protected java.util.Properties	monitoringProperties
protected java.util.Properties	properties
protected FullServicesContainer	servicesContainer
protected TelemetryFactory	telemetryFactory

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

lastActivityTimestampNanos, monitorExecutor, state, stop, terminationTimeoutSec

Constructor Summary

Constructors

Constructor and Description
HostMonitorV2Impl(@NonNull FullServicesContainer servicesContainer, @NonNull HostSpec hostSpec, @NonNull java.util.Properties properties, int failureDetectionTimeMillis, int failureDetectionIntervalMillis, int failureDetectionCount, @Nullable TelemetryCounter abortedConnectionsCounter)
HostMonitorV2Impl(@NonNull FullServicesContainer servicesContainer, @NonNull HostSpec hostSpec, @NonNull java.util.Properties properties, int failureDetectionTimeMillis, int failureDetectionIntervalMillis, int failureDetectionCount, @Nullable TelemetryCounter abortedConnectionsCounter, long terminationTimeoutSec, java.lang.String threadName) Store the monitoring configuration for a connection.

Method Summary

Modifier and Type	Method and Description
protected void	abortConnection(@NonNull java.sql.Connection connectionToAbort)
boolean	canDispose() Defines whether this monitor can be disposed.
void	close() Closes all resources used by this monitor.
protected long	getCurrentTimeNano()
java.util.List<Pair<java.lang.String,java.lang.Object>>	getSnapshotState()
void	monitor() Executes the monitoring loop for this monitor.
void	newContextRun()
void	processEvent(Event event) Processes an event.
protected void	reset()
void	start() Submits this monitor in a separate thread to begin its monitoring tasks.
void	startMonitoring(ConnectionContext context)
protected long	truncateNanoToSeconds(long timeNano)
protected void	updateNodeHealthStatus(boolean connectionValid, long statusCheckStartNano, long statusCheckEndNano)

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

getLastActivityTimestampNanos, getState, run, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jdbc.util.monitoring.Monitor

getLastActivityTimestampNanos, getState, stop

Methods inherited from interface java.lang.Runnable

run

Field Detail

abortExecutor

protected final java.util.concurrent.Executor abortExecutor

servicesContainer

protected final FullServicesContainer servicesContainer

telemetryFactory

protected final TelemetryFactory telemetryFactory

properties

protected final java.util.Properties properties

monitoringProperties

protected final java.util.Properties monitoringProperties

hostSpec

protected final HostSpec hostSpec

monitoringConn

protected AtomicConnection monitoringConn

abortedConnectionsCounter

protected final @Nullable TelemetryCounter abortedConnectionsCounter

Constructor Detail

HostMonitorV2Impl

public HostMonitorV2Impl(@NonNull FullServicesContainer servicesContainer,
                         @NonNull HostSpec hostSpec,
                         @NonNull java.util.Properties properties,
                         int failureDetectionTimeMillis,
                         int failureDetectionIntervalMillis,
                         int failureDetectionCount,
                         @Nullable TelemetryCounter abortedConnectionsCounter)

HostMonitorV2Impl

public HostMonitorV2Impl(@NonNull FullServicesContainer servicesContainer,
                         @NonNull HostSpec hostSpec,
                         @NonNull java.util.Properties properties,
                         int failureDetectionTimeMillis,
                         int failureDetectionIntervalMillis,
                         int failureDetectionCount,
                         @Nullable TelemetryCounter abortedConnectionsCounter,
                         long terminationTimeoutSec,
                         java.lang.String threadName)

Store the monitoring configuration for a connection.

Parameters:

servicesContainer - The telemetry factory to use to create telemetry data.

hostSpec - The HostSpec of the server this HostMonitorV2Impl instance is monitoring.

properties - The Properties containing additional monitoring configuration.

failureDetectionTimeMillis - A failure detection time in millis.

failureDetectionIntervalMillis - A failure detection interval in millis.

failureDetectionCount - A failure detection count.

abortedConnectionsCounter - Aborted connection telemetry counter.

terminationTimeoutSec - The monitor termination timeout in seconds.

threadName - The monitoring thread name

Method Detail

canDispose

public boolean canDispose()

Description copied from interface: Monitor

Defines whether this monitor can be disposed.

Specified by:

canDispose in interface Monitor

Overrides:

canDispose in class AbstractMonitor

Returns:

true if this monitor can be disposed, otherwise returns false.

start

public void start()

Description copied from interface: Monitor

Submits this monitor in a separate thread to begin its monitoring tasks.

Specified by:

start in interface Monitor

Overrides:

start in class AbstractMonitor

startMonitoring

public void startMonitoring(ConnectionContext context)

Specified by:

startMonitoring in interface HostMonitor

truncateNanoToSeconds

protected long truncateNanoToSeconds(long timeNano)

getCurrentTimeNano

protected long getCurrentTimeNano()

newContextRun

public void newContextRun()

monitor

public void monitor()

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.

Specified by:

monitor in interface Monitor

updateNodeHealthStatus

protected void updateNodeHealthStatus(boolean connectionValid,
                                      long statusCheckStartNano,
                                      long statusCheckEndNano)

abortConnection

protected void abortConnection(@NonNull java.sql.Connection connectionToAbort)

close

public void close()

Description copied from interface: Monitor

Closes all resources used by this monitor. This method will be called as part of Monitor.stop().

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface Monitor

Overrides:

close in class AbstractMonitor

reset

protected void reset()

processEvent

public void processEvent(Event event)

Description copied from interface: EventSubscriber

Processes an event. This method will only be called on this subscriber if it has subscribed to the event class via EventPublisher.subscribe(software.amazon.jdbc.util.events.EventSubscriber, java.util.Set<java.lang.Class<? extends software.amazon.jdbc.util.events.Event>>).

Specified by:

processEvent in interface EventSubscriber

Parameters:

event - the event to process.

getSnapshotState

public java.util.List<Pair<java.lang.String,java.lang.Object>> getSnapshotState()

Specified by:

getSnapshotState in interface StateSnapshotProvider