View a markdown version of this page

Migrazione da KCL 1.x a KCL 3.5.x+ - Amazon DynamoDB

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Migrazione da KCL 1.x a KCL 3.5.x+

Panoramica di

Questa guida fornisce istruzioni per migrare la tua applicazione consumer da KCL 1.x a KCL 3.5.x+. A causa delle differenze architetturali tra KCL 1.x e KCL 3.5.x+, la migrazione richiede l'aggiornamento di diversi componenti per garantire la compatibilità.

KCL 1.x utilizza classi e interfacce diverse rispetto a KCL 3.5.x+. Devi prima migrare le classi Record Processor, Record Processor Factory e Worker nel formato compatibile con KCL 3.5.x+ e seguire i passaggi di migrazione per la migrazione da KCL 1.x a KCL 3.5.x+.

Nota

KCL 3.5.x+ è supportato con Amazon DynamoDB Streams Kinesis Adapter versione 2.4.x+ sul sito web. https://github.com/awslabs/dynamodb-streams-kinesis-adapter GitHub

Fasi della migrazione

Fase 1: migrare l’elaboratore di record

L’esempio seguente mostra un elaboratore di record implementato per l’Adattatore Kinesis per i flussi DynamoDB con KCL 1.x:

package com.amazonaws.kcl; import com.amazonaws.services.kinesis.clientlibrary.exceptions.InvalidStateException; import com.amazonaws.services.kinesis.clientlibrary.exceptions.ShutdownException; import com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessorCheckpointer; import com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IRecordProcessor; import com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IShutdownNotificationAware; import com.amazonaws.services.kinesis.clientlibrary.lib.worker.ShutdownReason; import com.amazonaws.services.kinesis.clientlibrary.types.InitializationInput; import com.amazonaws.services.kinesis.clientlibrary.types.ProcessRecordsInput; import com.amazonaws.services.kinesis.clientlibrary.types.ShutdownInput; public class StreamsRecordProcessor implements IRecordProcessor, IShutdownNotificationAware { @Override public void initialize(InitializationInput initializationInput) { // // Setup record processor // } @Override public void processRecords(ProcessRecordsInput processRecordsInput) { for (Record record : processRecordsInput.getRecords()) { String data = new String(record.getData().array(), Charset.forName("UTF-8")); System.out.println(data); if (record instanceof RecordAdapter) { // record processing and checkpointing logic } } } @Override public void shutdown(ShutdownInput shutdownInput) { if (shutdownInput.getShutdownReason() == ShutdownReason.TERMINATE) { try { shutdownInput.getCheckpointer().checkpoint(); } catch (ShutdownException | InvalidStateException e) { throw new RuntimeException(e); } } } @Override public void shutdownRequested(IRecordProcessorCheckpointer checkpointer) { try { checkpointer.checkpoint(); } catch (ShutdownException | InvalidStateException e) { // // Swallow exception // e.printStackTrace(); } } }
Per RecordProcessor migrare la classe
  1. Modifica le interfacce da com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IRecordProcessor e com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IShutdownNotificationAware verso com.amazonaws.services.dynamodbv2.streamsadapter.processor.DynamoDBStreamsShardRecordProcessor come segue:

    // import com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IRecordProcessor; // import com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IShutdownNotificationAware; import com.amazonaws.services.dynamodbv2.streamsadapter.processor.DynamoDBStreamsShardRecordProcessor;
  2. Aggiorna le istruzioni di importazione per i metodi initialize e processRecords:

    // import com.amazonaws.services.kinesis.clientlibrary.types.InitializationInput; import software.amazon.kinesis.lifecycle.events.InitializationInput; // import com.amazonaws.services.kinesis.clientlibrary.types.ProcessRecordsInput; import com.amazonaws.services.dynamodbv2.streamsadapter.model.DynamoDBStreamsProcessRecordsInput;
  3. Sostituisci il metodo shutdownRequested con i seguenti nuovi metodi: leaseLost, shardEnded e shutdownRequested.

    // @Override // public void shutdownRequested(IRecordProcessorCheckpointer checkpointer) { // // // // This is moved to shardEnded(...) and shutdownRequested(ShutdownReauestedInput) // // // try { // checkpointer.checkpoint(); // } catch (ShutdownException | InvalidStateException e) { // // // // Swallow exception // // // e.printStackTrace(); // } // } @Override public void leaseLost(LeaseLostInput leaseLostInput) { } @Override public void shardEnded(ShardEndedInput shardEndedInput) { try { shardEndedInput.checkpointer().checkpoint(); } catch (ShutdownException | InvalidStateException e) { // // Swallow the exception // e.printStackTrace(); } } @Override public void shutdownRequested(ShutdownRequestedInput shutdownRequestedInput) { try { shutdownRequestedInput.checkpointer().checkpoint(); } catch (ShutdownException | InvalidStateException e) { // // Swallow the exception // e.printStackTrace(); } }

Segue la versione aggiornata della classe dell’elaboratore di record:

package com.amazonaws.codesamples; import software.amazon.kinesis.exceptions.InvalidStateException; import software.amazon.kinesis.exceptions.ShutdownException; import software.amazon.kinesis.lifecycle.events.InitializationInput; import software.amazon.kinesis.lifecycle.events.LeaseLostInput; import com.amazonaws.services.dynamodbv2.streamsadapter.model.DynamoDBStreamsProcessRecordsInput; import software.amazon.kinesis.lifecycle.events.ShardEndedInput; import software.amazon.kinesis.lifecycle.events.ShutdownRequestedInput; import software.amazon.dynamodb.streamsadapter.processor.DynamoDBStreamsShardRecordProcessor; import software.amazon.dynamodb.streamsadapter.adapter.DynamoDBStreamsKinesisClientRecord; import com.amazonaws.services.dynamodbv2.streamsadapter.processor.DynamoDBStreamsShardRecordProcessor; import com.amazonaws.services.dynamodbv2.streamsadapter.adapter.DynamoDBStreamsClientRecord; import software.amazon.awssdk.services.dynamodb.model.Record; public class StreamsRecordProcessor implements DynamoDBStreamsShardRecordProcessor { @Override public void initialize(InitializationInput initializationInput) { } @Override public void processRecords(DynamoDBStreamsProcessRecordsInput processRecordsInput) { for (DynamoDBStreamsKinesisClientRecord record: processRecordsInput.records()) Record ddbRecord = record.getRecord(); // processing and checkpointing logic for the ddbRecord } } @Override public void leaseLost(LeaseLostInput leaseLostInput) { } @Override public void shardEnded(ShardEndedInput shardEndedInput) { try { shardEndedInput.checkpointer().checkpoint(); } catch (ShutdownException | InvalidStateException e) { // // Swallow the exception // e.printStackTrace(); } } @Override public void shutdownRequested(ShutdownRequestedInput shutdownRequestedInput) { try { shutdownRequestedInput.checkpointer().checkpoint(); } catch (ShutdownException | InvalidStateException e) { // // Swallow the exception // e.printStackTrace(); } } }
Nota

L’Adattatore Kinesis per i flussi DynamoDB ora utilizza il modello dei record SDKv2. In SDKv2, gli oggetti AttributeValue complessi (BS, NS, M, L, SS) non restituiscono mai null. Utilizza i metodi hasBs(), hasNs(), hasM(), hasL(), hasSs() per verificare se questi valori esistono.

Fase 2: migrare il generatore dell’elaboratore di record

La fabbrica dell'elaboratore di record è responsabile per la creazione di elaboratori di record quando un lease è acquisito. Di seguito è illustrato un esempio di un generatore di KCL 1.x:

package com.amazonaws.codesamples; import software.amazon.dynamodb.AmazonDynamoDB; import com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IRecordProcessor; import com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IRecordProcessorFactory; public class StreamsRecordProcessorFactory implements IRecordProcessorFactory { @Override public IRecordProcessor createProcessor() { return new StreamsRecordProcessor(dynamoDBClient, tableName); } }
Per migrare RecordProcessorFactory
  • Modifica l’interfaccia implementata da com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IRecordProcessorFactory a software.amazon.kinesis.processor.ShardRecordProcessorFactory, come segue:

    // import com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IRecordProcessor; import software.amazon.kinesis.processor.ShardRecordProcessor; // import com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IRecordProcessorFactory; import software.amazon.kinesis.processor.ShardRecordProcessorFactory; // public class TestRecordProcessorFactory implements IRecordProcessorFactory { public class StreamsRecordProcessorFactory implements ShardRecordProcessorFactory { Change the return signature for createProcessor. // public IRecordProcessor createProcessor() { public ShardRecordProcessor shardRecordProcessor() {

Di seguito è riportato un esempio del processore di registrazione di fabbrica in 3.5.x+:

package com.amazonaws.codesamples; import software.amazon.kinesis.processor.ShardRecordProcessor; import software.amazon.kinesis.processor.ShardRecordProcessorFactory; public class StreamsRecordProcessorFactory implements ShardRecordProcessorFactory { @Override public ShardRecordProcessor shardRecordProcessor() { return new StreamsRecordProcessor(); } }

Fase 3: eseguire la migrazione del lavoratore

Nella versione 3.5.x+ di KCL, una nuova classe, chiamata Scheduler, sostituisce la classe Worker. Di seguito è illustrato un esempio di un lavoratore di KCL 1.x:

final KinesisClientLibConfiguration config = new KinesisClientLibConfiguration(...) final IRecordProcessorFactory recordProcessorFactory = new RecordProcessorFactory(); final Worker worker = StreamsWorkerFactory.createDynamoDbStreamsWorker( recordProcessorFactory, workerConfig, adapterClient, amazonDynamoDB, amazonCloudWatchClient);
Per migrare il lavoratore
  1. Modifica la dichiarazione import per la classe Worker nelle dichiarazioni di importazione delle classi Scheduler e ConfigsBuilder.

    // import com.amazonaws.services.kinesis.clientlibrary.lib.worker.Worker; import software.amazon.kinesis.coordinator.Scheduler; import software.amazon.kinesis.common.ConfigsBuilder;
  2. Importa StreamTracker e modifica l’importazione di StreamsWorkerFactory in StreamsSchedulerFactory.

    import software.amazon.kinesis.processor.StreamTracker; // import software.amazon.dynamodb.streamsadapter.StreamsWorkerFactory; import software.amazon.dynamodb.streamsadapter.StreamsSchedulerFactory;
  3. Seleziona la posizione da cui avviare l’applicazione. Può essere TRIM_HORIZON o LATEST.

    import software.amazon.kinesis.common.InitialPositionInStream; import software.amazon.kinesis.common.InitialPositionInStreamExtended;
  4. Creazione di un’istanza StreamTracker.

    StreamTracker streamTracker = StreamsSchedulerFactory.createSingleStreamTracker( streamArn, InitialPositionInStreamExtended.newInitialPosition(InitialPositionInStream.TRIM_HORIZON) );
  5. Crea l’oggetto AmazonDynamoDBStreamsAdapterClient.

    import software.amazon.dynamodb.streamsadapter.AmazonDynamoDBStreamsAdapterClient; import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider; import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider; ... AwsCredentialsProvider credentialsProvider = DefaultCredentialsProvider.create(); AmazonDynamoDBStreamsAdapterClient adapterClient = new AmazonDynamoDBStreamsAdapterClient( credentialsProvider, awsRegion);
  6. Crea l’oggetto ConfigsBuilder.

    import software.amazon.kinesis.common.ConfigsBuilder; ... ConfigsBuilder configsBuilder = new ConfigsBuilder( streamTracker, applicationName, adapterClient, dynamoDbAsyncClient, cloudWatchAsyncClient, UUID.randomUUID().toString(), new StreamsRecordProcessorFactory());
  7. Crea Scheduler con ConfigsBuilder come mostrato nell’esempio seguente:

    import java.util.UUID; import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient; import software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient; import software.amazon.awssdk.services.kinesis.KinesisAsyncClient; import software.amazon.kinesis.common.KinesisClientUtil; import software.amazon.kinesis.coordinator.Scheduler; ... DynamoDbAsyncClient dynamoClient = DynamoDbAsyncClient.builder().region(region).build(); CloudWatchAsyncClient cloudWatchClient = CloudWatchAsyncClient.builder().region(region).build(); DynamoDBStreamsPollingConfig pollingConfig = new DynamoDBStreamsPollingConfig(adapterClient); pollingConfig.idleTimeBetweenReadsInMillis(idleTimeBetweenReadsInMillis); // Use ConfigsBuilder to configure settings RetrievalConfig retrievalConfig = configsBuilder.retrievalConfig(); retrievalConfig.retrievalSpecificConfig(pollingConfig); CoordinatorConfig coordinatorConfig = configsBuilder.coordinatorConfig(); coordinatorConfig.clientVersionConfig(CoordinatorConfig.ClientVersionConfig.CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X_PHASE1); Scheduler scheduler = StreamsSchedulerFactory.createScheduler( configsBuilder.checkpointConfig(), coordinatorConfig, configsBuilder.leaseManagementConfig(), configsBuilder.lifecycleConfig(), configsBuilder.metricsConfig(), configsBuilder.processorConfig(), retrievalConfig, adapterClient );
Nota

La migrazione a KCL 3.5.x+ utilizza tre fasi:

  • Fase 1 (CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X_PHASE1): modalità pura compatibile con KCL 1.x. Nessun metadato specifico della migrazione viene scritto nella tabella di leasing. Ripristino sicuro a KCL v1 ridistribuendo il codice precedente. Usa questa fase per convalidare la stabilità.

  • Fase 2 (CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X): avvia la migrazione. Scrive WORKER_METRIC_STATS e Migration3.0 inserisce nella tabella dei contratti di locazione. KCL passa automaticamente al bilanciamento completo del carico 3.x quando tutti i lavoratori sono pronti. È supportato il rollback alla Fase 1 (tramite il KCL Migration Tool). Il rollback a KCL v1 non è più possibile.

  • Fase 3 (CLIENT_VERSION_CONFIG_3X): funzionalità completa di KCL 3.x. Impostato esplicitamente dal cliente o utilizzato come predefinito quando la configurazione viene rimossa. Stato del terminale, nessun rollback.

Queste impostazioni mantengono la compatibilità tra DynamoDB Streams Kinesis Adapter for KCL v3 e KCL v1, non tra KCL v2 e v3.

Importante

È necessario avviare la migrazione con (Fase 1). CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X_PHASE1 La fase 1 è retrocompatibile con KCL v1 e non scrive alcuna voce specifica della migrazione nella tabella di leasing, consentendo il rollback sicuro alla versione precedente di KCL semplicemente ridistribuendo il codice precedente. Dopo un accurato test di sicurezza nella Fase 1, puoi passare alla Fase 2 () per avviare la migrazione completa. CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X Se salti la Fase 1 e inizi direttamente con la Fase 2, le voci non relative al leasing vengono scritte immediatamente nella tabella dei lease, impedendo in modo permanente il rollback a KCL v1 senza una pulizia manuale di DynamoDB.

Fase 4: panoramica e consigli sulla configurazione di KCL 3.5.x+

Per una descrizione dettagliata delle configurazioni introdotte dopo KCL 1.x che sono rilevanti in KCL 3.5.x+, vedi Configurazioni KCL e configurazione del client di migrazione KCL. https://docs.aws.amazon.com//streams/latest/dev/kcl-configuration.html https://docs.aws.amazon.com//streams/latest/dev/kcl-migration.html#client-configuration

Importante

Invece di creare direttamente oggetti di,,, e, processorConfig e checkpointConfig coordinatorConfig leaseManagementConfigmetricsConfig, consigliamo di utilizzarli per impostare le configurazioni in retrievalConfig KCL 3.5.x+ e versioni successive ConfigsBuilder per evitare problemi di inizializzazione dello Scheduler. ConfigsBuilderfornisce un modo più flessibile e gestibile per configurare la tua applicazione KCL.

Configurazioni con valore predefinito di aggiornamento in KCL 3.5.x+

billingMode

Nella versione 1.x di KCL, il valore predefinito per billingMode è impostato su PROVISIONED. Tuttavia, con la versione 3.5.x+ di KCL, l'impostazione predefinita è (modalità su richiesta). billingMode PAY_PER_REQUEST Si consiglia di utilizzare la modalità con capacità on demand per la tabella di lease per regolare automaticamente la capacità in base all’utilizzo. Per indicazioni sull’utilizzo della capacità allocata per le tabelle di lease, consulta Best practices for the lease table with provisioned capacity mode.

idleTimeBetweenReadsInMillis

Nella versione 1.x di KCL, il valore predefinito per idleTimeBetweenReadsInMillis è impostato su 1.000 (o 1 secondo). La versione 3.5.x+ di KCL imposta il valore predefinito idleTimeBetweenReadsInMillis a 1.500 (o 1,5 secondi), ma Amazon DynamoDB Streams Kinesis Adapter sostituisce il valore predefinito a 1.000 (o 1 secondo).

Nuove configurazioni in KCL 3.5.x+

leaseAssignmentIntervalMillis

Questa configurazione definisce l’intervallo di tempo prima che gli shard di nuovo riscontro inizino l’elaborazione e viene calcolata come 1,5 × leaseAssignmentIntervalMillis. Se questa impostazione non è configurata in modo esplicito, l’intervallo di tempo predefinito è 1,5 × failoverTimeMillis. L’elaborazione di nuovi shard prevede la scansione della tabella di lease e l’interrogazione di un indice secondario globale (GSI) sulla tabella di lease. La riduzione di leaseAssignmentIntervalMillis aumenta la frequenza delle operazioni Scan e Query, con conseguente aumento dei costi di DynamoDB. Si consiglia di impostare questo valore su 2000 (o 2 secondi) per ridurre al minimo il ritardo nell’elaborazione di nuovi shard.

shardConsumerDispatchPollIntervalMillis

Questa configurazione definisce l’intervallo tra polling successivi da parte del consumer dello shard per attivare le transizioni di stato. Nella versione 1.x di KCL, questo comportamento era controllato dal parametro idleTimeInMillis, che non era esposto come impostazione configurabile. Con la versione 3.5.x+ di KCL, consigliamo di impostare questa configurazione in modo che corrisponda al valore utilizzato nella configurazione di KCL versione 1.x. idleTimeInMillis

Passaggio 5: migra da KCL 2.x a KCL 3.5.x+

Per garantire una transizione e una compatibilità fluide con la versione più recente di Kinesis Client Library (KCL), segui i passaggi 5-8 nelle istruzioni della guida alla migrazione per l'aggiornamento da KCL 2.x a KCL 3.5.x+. https://docs.aws.amazon.com//streams/latest/dev/kcl-migration-from-2-3.html#kcl-migration-from-2-3-worker-metrics

Per i problemi più comuni relativi alla risoluzione dei problemi di KCL 3.5.x+, vedi Risoluzione dei problemi delle applicazioni consumer di KCL. https://docs.aws.amazon.com//streams/latest/dev/troubleshooting-consumers.html