v3.0.1

What's Changed

• Update backward compatibility check script by @akidambisrinivasan in #1393
• Update version to 3.0.1-SNAPSHOT by @akidambisrinivasan in #1394
• Address KCLv3 issues from github by @akidambisrinivasan in #1398
• Fix checkpointOwner copy issue for multistream lease by @chenylee-aws in #1401
• Preparation for v3.0.1 by @chenylee-aws in #1402

Full Changelog: v3.0.0...v3.0.1

Release 3.0.0 of the Amazon Kinesis Client Library for Java

Changelog

For 1.x release notes, please see v1.x/CHANGELOG.md

For 2.x release notes, please see v2.x/CHANGELOG.md

---

Release 3.0.0 (November 06, 2024)

• New lease assignment / load balancing algorithm
  • KCL 3.x introduces a new lease assignment and load balancing algorithm. It assigns leases among workers based on worker utilization metrics and throughput on each lease, replacing the previous lease count-based lease assignment algorithm.
  • When KCL detects higher variance in CPU utilization among workers, it proactively reassigns leases from over-utilized workers to under-utilized workers for even load balancing. This ensures even CPU utilization across workers and removes the need to over-provision the stream processing compute hosts.
• Optimized DynamoDB RCU usage
  • KCL 3.x optimizes DynamoDB read capacity unit (RCU) usage on the lease table by implementing a global secondary index with leaseOwner as the partition key. This index mirrors the leaseKey attribute from the base lease table, allowing workers to efficiently discover their assigned leases by querying the index instead of scanning the entire table.
  • This approach significantly reduces read operations compared to earlier KCL versions, where workers performed full table scans, resulting in higher RCU consumption.
• Graceful lease handoff
  • KCL 3.x introduces a feature called "graceful lease handoff" to minimize data reprocessing during lease reassignments. Graceful lease handoff allows the current worker to complete checkpointing of processed records before transferring the lease to another worker. For graceful lease handoff, you should implement checkpointing logic within the existing shutdownRequested() method.
  • This feature is enabled by default in KCL 3.x, but you can turn off this feature by adjusting the configuration property isGracefulLeaseHandoffEnabled.
  • While this approach significantly reduces the probability of data reprocessing during lease transfers, it doesn't completely eliminate the possibility. To maintain data integrity and consistency, it's crucial to design your downstream consumer applications to be idempotent. This ensures that the application can handle potential duplicate record processing without adverse effects.
• New DynamoDB metadata management artifacts
  • KCL 3.x introduces two new DynamoDB tables for improved lease management:
    • Worker metrics table: Records CPU utilization metrics from each worker. KCL uses these metrics for optimal lease assignments, balancing resource utilization across workers. If CPU utilization metric is not available, KCL assigns leases to balance the total sum of shard throughput per worker instead.
    • Coordinator state table: Stores internal state information for workers. Used to coordinate in-place migration from KCL 2.x to KCL 3.x and leader election among workers.
  • Follow this documentation to add required IAM permissions for your KCL application.
• Other improvements and changes
  • Dependency on the AWS SDK for Java 1.x has been fully removed.
    • The Glue Schema Registry integration functionality no longer depends on AWS SDK for Java 1.x. Previously, it required this as a transient dependency.
    • Multilangdaemon has been upgraded to use AWS SDK for Java 2.x. It no longer depends on AWS SDK for Java 1.x.
  • idleTimeBetweenReadsInMillis (PollingConfig) now has a minimum default value of 200.
    • This polling configuration property determines the publishers wait time between GetRecords calls in both success and failure cases. Previously, setting this value below 200 caused unnecessary throttling. This is because Amazon Kinesis Data Streams supports up to five read transactions per second per shard for shared-throughput consumers.
  • Shard lifecycle management is improved to deal with edge cases around shard splits and merges to ensure records continue being processed as expected.
• Migration
  • The programming interfaces of KCL 3.x remain identical with KCL 2.x for an easier migration, with the exception of those applications that do not use the recommended approach of using the Config Builder. These applications will have to refer to the troubleshooting guide. For detailed migration instructions, please refer to the Migrate consumers from KCL 2.x to KCL 3.x page in the Amazon Kinesis Data Streams developer guide.
• Configuration properties
  • New configuration properties introduced in KCL 3.x are listed in this doc.
  • Deprecated configuration properties in KCL 3.x are listed in this doc. You need to keep the deprecated configuration properties during the migration from any previous KCL version to KCL 3.x.
• Metrics
  • New CloudWatch metrics introduced in KCL 3.x are explained in the Monitor the Kinesis Client Library with Amazon CloudWatch in the Amazon Kinesis Data Streams developer guide. The following operations are newly added in KCL 3.x:
    • LeaseAssignmentManager
    • WorkerMetricStatsReporter
    • LeaseDiscovery

Release 1.15.2 of the Amazon Kinesis Client Library for Java

Release (1.15.2 - Aug 14, 2024)

• #1371 Fix a bug in debug and trace logging levels for worker
• #1224 Modify RecordProcessorCheckpointer#advancePosition Metrics usage to ensure proper closure
• #1345 Generate wrappers from proto files instead of shipping them directly
• #1346 Upgrade com.google.protobuf:protobuf-java from 3.23.4 to 4.27.1
• #1338 Upgrade org.apache.logging.log4j:log4j-api from 2.20.0 to 2.23.1
• #1327 Upgrade com.google.guava:guava from 33.0.0-jre to 33.2.0-jre
• #1283 Upgrade com.fasterxml.jackson.core:jackson-core from 2.15.2 to 2.17.0
• #1284 Upgrade aws-java-sdk.version from 1.12.647 to 1.12.681
• #1288 Upgrade commons-logging:commons-logging from 1.2 to 1.3.1
• #1289 Upgrade org.projectlombok:lombok from 1.18.22 to 1.18.32
• #1248 Upgrade org.apache.maven.plugins:maven-surefire-plugin from 2.22.2 to 3.2.5
• #1234 Upgrade org.apache.maven.plugins:maven-javadoc-plugin from 3.4.1 to 3.6.3
• #1137 Upgrade maven-failsafe-plugin from 2.22.2 to 3.1.2
• #1134 Upgrade jackson-core from 2.15.0 to 2.15.2
• #1119 Upgrade maven-source-plugin from 3.2.1 to 3.3.0
• #1165 Upgrade protobuf-java from 3.19.6 to 3.23.4

Release 2.6.0 of Amazon Kinesis Client Library for Java

Release 2.6.0 (2024-05-01)

• #1317 Add enablePriorityLeaseAssignment config
• #1320 Update lease taker to get unassigned leases
• #1318 Internally construct and use stream ARNs for all streams in multi-stream mode
• #1291 Update RetrievalFactory implementations to utilize the StreamIdentifier field of StreamConfig
• #1308 Move shutdownComplete call to ShardConsumer
• #1313 Add additional integration tests for multi-stream and cross account access
• #1273 Optimize currentStreamConfigMap by cleaning up lingering streams
• #1302 Fix gracefulShutdown behavior in Scheduler

Release 2.5.8 of Amazon Kinesis Client Library for Java

Release 2.5.8 (2024-03-27)

• #1278 Upgrade awssdk.version from 2.25.3 to 2.25.11
• #1279 Upgrade org.apache.maven.plugins:maven-gpg-plugin from 3.1.0 to 3.2.1
• #1280 Upgrade org.apache.commons:commons-lang3 from 3.12.0 to 3.14.0
• #1282 Upgrade org.apache.maven.plugins:maven-javadoc-plugin from 3.5.0 to 3.6.3
• #1277 Reuse 'ShardSyncTaskManager' instance for existing stream to avoid duplicate enqueue of 'ShardSyncTask'

Release 2.5.7 of Amazon Kinesis Client Library for Java

Changelog

For 1.x release notes, please see v1.x/CHANGELOG.md

---

Release 2.5.7 (2024-03-19)

• #1275 Update PollingConfig maxRecords method to return PollingConfig

• #1236 Upgrade commons-io:commons-io from 2.11.0 to 2.15.1

• #1189 Upgrade org.apache.maven.plugins:maven-resources-plugin from 3.3.0 to 3.3.1

• #1139 Upgrade maven-surefire-plugin from 2.22.2 to 3.1.2

• #1138 Upgrade maven-failsafe-plugin from 2.22.2 to 3.1.2

• #1125 Upgrade maven-gpg-plugin from 3.0.1 to 3.1.0

Release v2.5.6 of Amazon Kinesis Client Library for Java

Release 2.5.6 (2024-03-08)

• #1271 Adding snapshot for 2.5.6-SNAPSHOT
• #1268 Upgrade ch.qos.logback:logback-classic dependency from 1.3.12 to 1.3.14
• #1268 Upgrade awssdk.version from 2.20.43 to 2.25.3
• #1268 Upgrade aws-java-sdk.version from 1.12.405 to 1.12.668
• #1268 Upgrade gsr.version from 1.1.17 to 1.1.19

Release 2.5.5 of the Amazon Kinesis Client Library for Java

Release 2.5.5 (2024-02-26)

• #1257 Prevent improper error logging during worker shutdown
• #1260 Add Deletion protection config
• #1258 Fix issue in configuring metricsEnabledDimensions
• #1259 Add snapshot to version

Release 1.15.1 of the Amazon Kinesis Client Library for Java

Release (1.15.1 - Feb 5, 2023)

• #1214 Added backoff logic for ShardSyncTaskIntegrationTest
• #1214 Upgrade Guava version from 31.0.1 to 32.1.1
• #1252 Upgrade aws-java-sdk from 1.12.406 to 1.12.647

Release 2.5.4 of the Amazon Kinesis Client Library for Java

Release 2.5.4 (December 12, 2023)
#1232 Upgrade ch.qos.logback:logback-classic dependency from 1.3.0 to 1.3.12 in /amazon-kinesis-client
#1233 Upgrade ch.qos.logback:logback-classic dependency from 1.3.0 to 1.3.12 in /amazon-kinesis-client-multilang
#1230 Bug fix which now allows MultiLangDaemon to configure idleTimeBetweenReadsInMillis
#1229 Added link to javadoc.io-hosted Javadoc in the README
#1218 Added doc for leases and the lease lifecycle to help explain lease lifecycle logic.
#1226 Upgraded KCL from 2.5.3 to 2.5.4-SNAPSHOT