software.amazon.kinesis.worker.metricstats.delegate

Class LegacyTableWorkerMetricStatsDAODelegate

java.lang.Object

software.amazon.kinesis.worker.metricstats.delegate.WorkerMetricStatsDAODelegate<WorkerMetricStats.LegacyWorkerMetricStats>

software.amazon.kinesis.worker.metricstats.delegate.LegacyTableWorkerMetricStatsDAODelegate

public class LegacyTableWorkerMetricStatsDAODelegate
extends WorkerMetricStatsDAODelegate<WorkerMetricStats.LegacyWorkerMetricStats>

Delegate for the legacy (separate) WorkerMetricStats DDB table.

The legacy table uses wid as its partition key, which is defined in WorkerMetricStats.LegacyWorkerMetricStats.

On initialize(), checks if the legacy table exists. If it does not exist, the delegate is marked as not enabled and all read operations become no-ops (returning empty collections). Write operations on a non-enabled delegate will throw InvalidStateException.

The legacy table should only be deleted after the table migration status moves to COMPLETE, at which point no read/write calls should be routed to this delegate.

Field Summary

Fields inherited from class software.amazon.kinesis.worker.metricstats.delegate.WorkerMetricStatsDAODelegate

log, table, tableName

Constructor Summary

Constructors

Constructor and Description
LegacyTableWorkerMetricStatsDAODelegate(software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDbAsyncClient, LeaseManagementConfig.WorkerMetricsTableConfig tableConfig, Long workerMetricsReporterFrequencyMillis)

Method Summary

Modifier and Type	Method and Description
boolean	deleteMetrics(WorkerMetricStats workerMetrics) Delete the worker metric stats entry with a conditional check on lastUpdateTime.
List<WorkerMetricStats>	getAllWorkerMetricStats() Retrieve all worker metric stats entries from the backing table.
void	initialize() Initialize the delegate.
boolean	isEnabled()
protected WorkerMetricStats.LegacyWorkerMetricStats	toEntity(WorkerMetricStats workerMetrics) For the legacy table, simply cast to LegacyWorkerMetricStats using the builder.
void	updateMetrics(WorkerMetricStats workerMetrics) Update (or create) the worker metric stats for a given worker.

Methods inherited from class software.amazon.kinesis.worker.metricstats.delegate.WorkerMetricStatsDAODelegate

getDynamoDbAsyncClient, getTableName

Methods inherited from class java.lang.Object

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

Constructor Detail

LegacyTableWorkerMetricStatsDAODelegate

public LegacyTableWorkerMetricStatsDAODelegate(software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDbAsyncClient,
                                               LeaseManagementConfig.WorkerMetricsTableConfig tableConfig,
                                               Long workerMetricsReporterFrequencyMillis)

Method Detail

initialize

public void initialize()
                throws DependencyException

Description copied from class: WorkerMetricStatsDAODelegate

Initialize the delegate. Implementations may check table existence or perform other setup.

Specified by:

initialize in class WorkerMetricStatsDAODelegate<WorkerMetricStats.LegacyWorkerMetricStats>

Throws:

DependencyException - if initialization fails due to external dependencies

toEntity

protected WorkerMetricStats.LegacyWorkerMetricStats toEntity(WorkerMetricStats workerMetrics)

For the legacy table, simply cast to LegacyWorkerMetricStats using the builder.

Specified by:

toEntity in class WorkerMetricStatsDAODelegate<WorkerMetricStats.LegacyWorkerMetricStats>

isEnabled

public boolean isEnabled()

Returns:

true if the legacy table exists and this delegate is enabled for operations

getAllWorkerMetricStats

public List<WorkerMetricStats> getAllWorkerMetricStats()
                                                throws DependencyException,
                                                       InvalidStateException,
                                                       ProvisionedThroughputException

Retrieve all worker metric stats entries from the backing table. In the legacy table entries are not filtered by entity type since during migration old workers will not be writing the entity type.

Specified by:

getAllWorkerMetricStats in class WorkerMetricStatsDAODelegate<WorkerMetricStats.LegacyWorkerMetricStats>

Returns:

list of all WorkerMetricStats entries

Throws:

DependencyException - if DynamoDB operation fails unexpectedly

InvalidStateException - if the backing table does not exist

ProvisionedThroughputException - if DynamoDB lacks capacity

updateMetrics

public void updateMetrics(WorkerMetricStats workerMetrics)
                   throws DependencyException,
                          InvalidStateException,
                          ProvisionedThroughputException

Description copied from class: WorkerMetricStatsDAODelegate

Update (or create) the worker metric stats for a given worker. Performs an upsert, ignoring null attributes.

Overrides:

updateMetrics in class WorkerMetricStatsDAODelegate<WorkerMetricStats.LegacyWorkerMetricStats>

Parameters:

workerMetrics - the worker metrics to persist

Throws:

DependencyException - if DynamoDB operation fails unexpectedly

InvalidStateException - if the backing table does not exist

ProvisionedThroughputException - if DynamoDB lacks capacity

deleteMetrics

public boolean deleteMetrics(WorkerMetricStats workerMetrics)
                      throws DependencyException,
                             InvalidStateException,
                             ProvisionedThroughputException

Description copied from class: WorkerMetricStatsDAODelegate

Delete the worker metric stats entry with a conditional check on lastUpdateTime. If the worker has come alive and updated the lastUpdateTime since the provided entry was read, the deletion will fail gracefully.

Overrides:

deleteMetrics in class WorkerMetricStatsDAODelegate<WorkerMetricStats.LegacyWorkerMetricStats>

Parameters:

workerMetrics - the entry to delete (workerId and lastUpdateTime required)

Returns:

true if deleted, false if the conditional check failed

Throws:

DependencyException - if DynamoDB operation fails unexpectedly

InvalidStateException - if the backing table does not exist

ProvisionedThroughputException - if DynamoDB lacks capacity