Skip to content

Latest commit

 

History

History
515 lines (439 loc) · 43.1 KB

CHANGELOG.md

File metadata and controls

515 lines (439 loc) · 43.1 KB
Raw

Changelog

Latest 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 (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 (1.15.0 - Jun 8, 2023)

  • #1108 Add support for Stream ARNs
  • #1111 More consistent testing behavior with HashRangesAreAlwaysComplete
  • #1054 Upgrade log4j-core from 2.17.1 to 2.20.0
  • #1103 Upgrade jackson-core from 2.13.0 to 2.15.0
  • #943 Upgrade nexus-staging-maven-plugin from 1.6.8 to 1.6.13
  • #1044 Upgrade aws-java-sdk.version from 1.12.406 to 1.12.408
  • #1055 Upgrade maven-compiler-plugin from 3.10.0 to 3.11.0

Release (1.14.10 - Feb 15, 2023)

  • Updated aws-java-sdk from 1.12.130 to 1.12.406
  • Updated com.google.protobuf from 3.19.4 to 3.19.6

Release (1.14.9 - Dec 14, 2022)

  • #995 Every other change for DynamoDBStreamsKinesis Adapter Compatibility
  • #970 PeriodicShardSyncManager Changes Needed for DynamoDBStreamsKinesisAdapter

Release (1.14.8 - Feb 24, 2022)

Release (1.14.7 - Dec 22, 2021)

  • #881 Update log4j test dependency from 2.16.0 to 2.17.0 and some other dependencies

Release (1.14.6 - Dec 15, 2021)

  • #876 Update log4j test dependency from 2.15.0 to 2.16.0

Release (1.14.5 - Dec 10, 2021)

  • #872 Update log4j test dependency from 1.2.17 to 2.15.0
  • #873 Upgrading version of AWS Java SDK to 1.12.128

Release (1.14.4 - June 14, 2021)

  • Milestone#61
  • #816 Updated the Worker shutdown logic to make sure that the LeaseCleanupManager also terminates all the threads that it has started.
  • #821 Upgrading version of AWS Java SDK to 1.12.3

Release (1.14.3 - May 3, 2021)

  • Milestone#60
  • #811 Fixing a bug in KinesisProxy that can lead to undetermined behavior during partial failures.
  • #811 Adding guardrails to handle duplicate shards from the service.

Release (1.14.2 - February 24, 2021)

  • Milestone#57
  • #790 Fixing a bug that caused paginated ListShards calls with the ShardFilter parameter to fail when the lease table was being initialized.

Release (1.14.1 - January 27, 2021)

  • Milestone#56

  • Fix for cross DDB table interference when multiple KCL applications are run in same JVM.

  • Fix and guards to avoid potential checkpoint rewind during shard end, which may block children shard processing.

  • Fix for thread cycle wastage on InitializeTask for deleted shard.

  • Improved logging in LeaseCleanupManager that would indicate why certain shards are not cleaned up from the lease table.

Release (1.14.0 - August 17, 2020)

  • Milestone#50

  • Behavior of shard synchronization is moving from each worker independently learning about all existing shards to workers only discovering the children of shards that each worker owns. This optimizes memory usage, lease table IOPS usage, and number of calls made to kinesis for streams with high shard counts and/or frequent resharding.

  • When bootstrapping an empty lease table, KCL utilizes the ListShard API's filtering option (the ShardFilter optional request parameter) to retrieve and create leases only for a snapshot of shards open at the time specified by the ShardFilter parameter. The ShardFilter parameter enables you to filter out the response of the ListShards API, using the Type parameter. KCL uses the Type filter parameter and the following of its valid values to identify and return a snapshot of open shards that might require new leases.

    • Currently, the following shard filters are supported:
      • AT_TRIM_HORIZON - the response includes all the shards that were open at TRIM_HORIZON.
      • AT_LATEST - the response includes only the currently open shards of the data stream.
      • AT_TIMESTAMP - the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open.
    • ShardFilter is used when creating leases for an empty lease table to initialize leases for a snapshot of shards specified at KinesisClientLibConfiguration#initialPositionInStreamExtended.
    • For more information about ShardFilter, see the official AWS documentation on ShardFilter.

  • Introducing support for the ChildShards response of the GetRecords API to perform lease/shard synchronization that happens at SHARD_END for closed shards, allowing a KCL worker to only create leases for the child shards of the shard it finished processing.

    • For KCL 1.x applications, this uses the ChildShards response of the GetRecords API.
    • For more information, see the official AWS Documentation on GetRecords and ChildShard.

  • KCL now also performs additional periodic shard/lease scans in order to identify any potential holes in the lease table to ensure the complete hash range of the stream is being processed and create leases for them if required. When KinesisClientLibConfiguration#shardSyncStrategyType is set to ShardSyncStrategyType.SHARD_END, PeriodicShardSyncManager#leasesRecoveryAuditorInconsistencyConfidenceThreshold will be used to determine the threshold for number of consecutive scans containing holes in the lease table after which to enforce a shard sync. When KinesisClientLibConfiguration#shardSyncStrategyType is set to ShardSyncStrategyType.PERIODIC, leasesRecoveryAuditorInconsistencyConfidenceThreshold is ignored.

    • New configuration options are available to configure PeriodicShardSyncManager in KinesisClientLibConfiguration
    Name Default Description
    leasesRecoveryAuditorInconsistencyConfidenceThreshold 3 Confidence threshold for the periodic auditor job to determine if leases for a stream in the lease table is inconsistent. If the auditor finds same set of inconsistencies consecutively for a stream for this many times, then it would trigger a shard sync. Only used for ShardSyncStrategyType.SHARD_END.
    • New CloudWatch metrics are also now emitted to monitor the health of PeriodicShardSyncManager:
    Name Description
    NumStreamsWithPartialLeases Number of streams that had holes in their hash ranges.
    NumStreamsToSync Number of streams which underwent a full shard sync.

  • Introducing deferred lease cleanup. Leases will be deleted asynchronously by LeaseCleanupManager upon reaching SHARD_END, when a shard has either expired past the stream’s retention period or been closed as the result of a resharding operation.

    • New configuration options are available to configure LeaseCleanupManager.
    Name Default Description
    leaseCleanupIntervalMillis 1 minute Interval at which to run lease cleanup thread.
    completedLeaseCleanupIntervalMillis 5 minutes Interval at which to check if a lease is completed or not.
    garbageLeaseCleanupIntervalMillis 30 minutes Interval at which to check if a lease is garbage (i.e trimmed past the stream's retention period) or not.

  • Including an optimization to KinesisShardSyncer to only create leases for one layer of shards.

  • Changing default shard prioritization strategy to be NoOpShardPrioritization to allow prioritization of completed shards. Customers who are upgrading to this version and are reading from TRIM_HORIZON should continue using ParentsFirstShardPrioritization while upgrading.

  • Upgrading version of AWS SDK to 1.11.844.

  • #719 Upgrading version of Google Protobuf to 3.11.4.

  • #712 Allowing KCL to consider lease tables in UPDATING healthy.

Release 1.13.3 (1.13.3 March 2, 2020)

[Milestone#49] (https://github.com/awslabs/amazon-kinesis-client/milestone/49）

  • Refactoring shard closure verification performed by ShutdownTask.
  • Fixing the bug in ShardSyncTaskManager to resolve the issue of new shards not being processed after resharding.

Release 1.13.2 （Janurary 13, 2020）

  • Adding backward compatible constructors that use the default DDB Billing Mode (#673)

Release 1.13.1 (December 31, 2019)

Milestone#44

  • Adding BillingMode Support to KCL 1.x. This enables the customer to specify if they want provisioned capacity for DDB, or pay per request.
  • Ensure ShardSyncTask invocation from ShardSyncTaskManager for pending ShardEnd events.
  • Fix the LeaseManagementIntegrationTest failure.

Release 1.13.0 (November 5, 2019)

Milestone#42

  • Handling completed and blocked tasks better during graceful shutdown

Release 1.12.0 (October 17, 2019)

Milestone#41

  • Adding logging around shard end codepaths.
  • Updating checkpointing failure message to refer to javadocs.
  • Updating Sonatype to dedicated AWS endpoint.
  • Introducing a validation step to verify if ShardEnd is reached, to prevent shard consumer stuck scenarios in the event of malformed response from service.
  • Updating AWS SDK to 1.11.655

Release 1.11.2 (August 15, 2019)

Milestone#35

  • Added support for metrics emission in PeriodicShardSyncer.

Release 1.11.1 (August 9, 2019)

Milestone#34

  • Updated the version of the AWS Java SDK to 1.11.603.
  • Added logging to KinesisDataFetcher when reaching the end of a shard due to a null next iterator.

Release 1.11.0 (August 7, 2019)

Milestone#33

  • Improved exception handling and logging in KinesisClientLibLeaseCoordinator to avoid NullPointerExceptions when no leases are found.
  • Introducing optional new periodic shard sync strategy to perform shard discovery and lease cleanup on a single worker.

Release 1.10.0 (April 8, 2019)

Milestone#31

Release 1.9.3 (October 30, 2018)

Release 1.9.2 (September 4, 2018)

  • Allow use of Immutable Clients
  • Allow the use of AT_TIMESTAMP for MultiLang Daemon Clients.
  • Update the cache for KinesisProxy#getShard on cache misses.
  • Changed release process to use a standard process.
  • Removed tests that expected a null region response for unknown regions.
  • Updated the version of the AWS Java SDK to 1.11.400

Release 1.9.1 (April 30, 2018)

  • Added the ability to create a prepared checkpoint when at SHARD_END.
  • Added the ability to subscribe to worker state change events.
  • Added support for custom lease managers.
    A custom LeaseManager can be provided to Worker.Builder that will be used to provide lease services. This makes it possible to implement custom lease management systems in addition to the default DynamoDB system.
  • Updated the version of the AWS Java SDK to 1.11.219

Release 1.9.0 (February 6, 2018)

  • Introducing support for ListShards API. This API is used in place of DescribeStream API to provide more throughput during ShardSyncTask. Please consult the AWS Documentation for ListShards for more information.

    • ListShards supports higher call rate, which should reduce instances of throttling when attempting to synchronize the shard list.
    • WARNING: ListShards is a new API, and may require updating any explicit IAM policies
    • Added configuration parameters for ListShards usage
    Name Default Description
    listShardsBackoffTimeInMillis 1500 ms This is the default backoff time between 2 ListShards calls when throttled.
    listShardsRetryAttempts 50 This is the maximum number of times the KinesisProxy will retry to make ListShards calls on being throttled.

  • Updating the version of AWS Java SDK to 1.11.272.

    • Version 1.11.272 is now the minimum support version of the SDK.

  • Deprecating the following methods, and classes. These methods, and classes will be removed in a future release.

Release 1.8.10

  • Allow providing a custom IKinesisProxy implementation.
  • Checkpointing on a different thread should no longer emit a warning about NullMetricsScope.
  • Upgraded the AWS Java SDK to version 1.11.271

Release 1.8.9

  • Allow disabling check for the case where a child shard has an open parent shard.
    There is a race condition where it's possible for the a parent shard to appear open, while having child shards. This check can now be disabled by setting ignoreUnexpectedChildShards to true.
  • Upgraded the AWS SDK for Java to 1.11.261

Release 1.8.8

  • Fixed issues with leases losses due to ExpiredIteratorException in PrefetchGetRecordsCache and AsynchronousFetchingStrategy.
    PrefetchGetRecordsCache will request for a new iterator and start fetching data again.

  • Added warning message for long running tasks.
    Logging long running tasks can be enabled by setting the following configuration property:

    Name Default Description
    logWarningForTaskAfterMillis Not set Milliseconds after which the logger will log a warning message for the long running task

  • Handling spurious lease renewal failures gracefully.
    Added better handling of DynamoDB failures when updating leases. These failures would occur when a request to DynamoDB appeared to fail, but was actually successful.

  • ShutdownTask gets retried if the previous attempt on the ShutdownTask fails.

  • Fix for using maxRecords from KinesisClientLibConfiguration in GetRecordsCache for fetching records.

Release 1.8.7

  • Don't add a delay for synchronous requests to Kinesis
    Removes a delay that had been added for synchronous GetRecords calls to Kinesis.

Release 1.8.6

  • Add prefetching of records from Kinesis
    Prefetching will retrieve and queue additional records from Kinesis while the application is processing existing records.
    Prefetching can be enabled by setting dataFetchingStrategy to PREFETCH_CACHED. Once enabled an additional fetching thread will be started to retrieve records from Kinesis. Retrieved records will be held in a queue until the application is ready to process them.
    Pre-fetching supports the following configuration values:

    Name Default Description
    dataFetchingStrategy DEFAULT Which data fetching strategy to use
    maxPendingProcessRecordsInput 3 The maximum number of process records input that can be queued
    maxCacheByteSize 8 MiB The maximum number of bytes that can be queued
    maxRecordsCount 30,000 The maximum number of records that can be queued
    idleMillisBetweenCalls 1,500 ms The amount of time to wait between calls to Kinesis

Release 1.8.5 (September 26, 2017)

  • Only advance the shard iterator for the accepted response.
    This fixes a race condition in the KinesisDataFetcher when it's being used to make asynchronous requests. The shard iterator is now only advanced when the retriever calls DataFetcherResult#accept().

Release 1.8.4 (September 22, 2017)

  • Create a new completion service for each request.
    This ensures that canceled tasks are discarded. This will prevent a cancellation exception causing issues processing records.

Release 1.8.3 (September 22, 2017)

Release 1.8.2 (September 20, 2017)

  • Add support for two phase checkpoints
    Applications can now set a pending checkpoint, before completing the checkpoint operation. Once the application has completed its checkpoint steps, the final checkpoint will clear the pending checkpoint.
    Should the checkpoint fail the attempted sequence number is provided in the InitializationInput#getPendingCheckpointSequenceNumber otherwise the value will be null.
  • Support timeouts, and retry for GetRecords calls.
    Applications can now set timeouts for GetRecord calls to Kinesis. As part of setting the timeout, the application must also provide a thread pool size for concurrent requests.
  • Notification when the lease table is throttled
    When writes, or reads, to the lease table are throttled a warning will be emitted. If you're seeing this warning you should increase the IOPs for your lease table to prevent processing delays.
  • Support configuring the graceful shutdown timeout for MultiLang Clients
    This adds support for setting the timeout that the Java process will wait for the MutliLang client to complete graceful shutdown. The timeout can be configured by adding shutdownGraceMillis to the properties file set to the number of milliseconds to wait.

Release 1.8.1 (August 2, 2017)

  • Support timeouts for calls to the MultiLang Daemon This adds support for setting a timeout when dispatching records to the client record processor. If the record processor doesn't respond within the timeout the parent Java process will be terminated. This is a temporary fix to handle cases where the KCL becomes blocked while waiting for a client record processor. The timeout for the this can be set by adding timeoutInSeconds = <timeout value>. The default for this is no timeout.
    Setting this can cause the KCL to exit suddenly, before using this ensure that you have an automated restart for your application

Release 1.8.0 (July 25, 2017)

  • Execute graceful shutdown on its own thread
  • Added support for controlling the size of the lease renewer thread pool
  • Require Java 8 and later
    Java 8 is now required for versions 1.8.0 of the amazon-kinesis-client and later.

Release 1.7.6 (June 21, 2017)

  • Added support for graceful shutdown in MultiLang Clients
  • Updated documentation for v2.IRecordProcessor#shutdown, and KinesisClientLibConfiguration#idleTimeBetweenReadsMillis
  • Updated to version 1.11.151 of the AWS Java SDK

Release 1.7.5 (April 7, 2017)

  • Correctly handle throttling for DescribeStream, and save accumulated progress from individual calls.
  • Upgrade to version 1.11.115 of the AWS Java SDK

Release 1.7.4 (February 27, 2017)

  • Fixed an issue building JavaDoc for Java 8.
  • Reduce Throttling Messages to WARN, unless throttling occurs 6 times consecutively.
  • Fixed two bugs occurring in requestShutdown.
    • Fixed a bug that prevented the worker from shutting down, via requestShutdown, when no leases were held.
    • Fixed a bug that could trigger a NullPointerException if leases changed during requestShutdown.
    • PR #139
  • Upgraded the AWS SDK Version to 1.11.91
  • Use an executor returned from ExecutorService.newFixedThreadPool instead of constructing it by hand.
  • Correctly initialize DynamoDB client, when endpoint is explicitly set.

Release 1.7.3 (January 9, 2017)

Release 1.7.2 (November 7, 2016)

  • MultiLangDaemon Feature Updates The MultiLangDaemon has been upgraded to use the v2 interfaces, which allows access to enhanced checkpointing, and more information during record processor initialization. The MultiLangDaemon clients must be updated before they can take advantage of these new features.

Release 1.7.1 (November 3, 2016)

  • General
    • Allow disabling shard synchronization at startup.
      • Applications can disable shard synchronization at startup. Disabling shard synchronization can application startup times for very large streams.
      • PR #102
    • Applications can now request a graceful shutdown, and record processors that implement the IShutdownNotificationAware will be given a chance to checkpoint before being shutdown.
  • MultiLangDaemon
    • Applications can now use credential provides that accept string parameters.
    • Applications can now use different credentials for each service.

Release 1.7.0 (August 22, 2016)

  • Add support for time based iterators (See GetShardIterator Documentation)
    • PR #94 The KinesisClientLibConfiguration now supports providing an initial time stamp position.
    • This position is only used if there is no current checkpoint for the shard.
    • This setting cannot be used with DynamoDB Streams Resolves Issue #88
  • Allow Prioritization of Parent Shards for Task Assignment
    • PR #95 The KinesisClientLibconfiguration now supports providing a ShardPrioritization strategy. This strategy controls how the Worker determines which ShardConsumer to call next. This can improve processing for streams that split often, such as DynamoDB Streams.
  • Remove direct dependency on aws-java-sdk-core, to allow independent versioning.
    • PR #92 You may need to add a direct dependency on aws-java-sdk-core if other dependencies include an older version.

Release 1.6.5 (July 25, 2016)

  • Change LeaseManager to call DescribeTable before attempting to create the lease table.
  • Allow DynamoDB lease table name to be specified
  • Add approximateArrivalTimestamp for JsonFriendlyRecord
  • Shutdown lease renewal thread pool on exit.
  • Wait for CloudWatch publishing thread to finish before exiting.
  • Added unit, and integration tests for the library.

Release 1.6.4 (July 6, 2016)

  • Upgrade to AWS SDK for Java 1.11.14
  • Maven Artifact Signing Change
    • Artifacts are now signed by the identity Amazon Kinesis Tools <amazon-kinesis-tools@amazon.com>

Release 1.6.3 (May 12, 2016)

  • Fix format exception caused by DEBUG log in LeaseTaker Issue # 68

Release 1.6.2 (March 23, 2016)

  • Support for specifying max leases per worker and max leases to steal at a time.
  • Support for specifying initial DynamoDB table read and write capacity.
  • Support for parallel lease renewal.
  • Support for graceful worker shutdown.
  • Change DefaultCWMetricsPublisher log level to debug. PR # 49
  • Avoid NPE in MLD record processor shutdown if record processor was not initialized. Issue # 29

Release 1.6.1 (September 23, 2015)

Release 1.6.0 (July 31, 2015)

Release 1.5.1 (July 20, 2015)

  • KCL maven artifact 1.5.0 does not work with JDK 7. This release addresses this issue.

Release 1.5.0 (July 9, 2015)

  • Metrics Enhancements
    • Support metrics level and dimension configurations to control CloudWatch metrics emitted by the KCL.
    • Add new metrics that track time spent in record processor methods.
    • Disable WorkerIdentifier dimension by default.
  • Exception Reporting — Do not silently ignore exceptions in ShardConsumer.
  • AWS SDK Component Dependencies — Depend only on AWS SDK components that are used.

Release 1.4.0 (June 2, 2015)

  • Integration with the Kinesis Producer Library (KPL)
    • Automatically de-aggregate records put into the Kinesis stream using the KPL.
    • Support checkpointing at the individual user record level when multiple user records are aggregated into one Kinesis record using the KPL.

See Consumer De-aggregation with the KCL for details.

Release 1.3.0 (May 22, 2015)

  • A new metric called "MillisBehindLatest", which tracks how far consumers are from real time, is now uploaded to CloudWatch.

Release 1.2.1 (January 26, 2015)

  • MultiLangDaemon — Changes to the MultiLangDaemon to make it easier to provide a custom worker.

Release 1.2 (October 21, 2014)

  • Multi-Language Support — Amazon KCL now supports implementing record processors in any language by communicating with the daemon over STDIN and STDOUT. Python developers can directly use the Amazon Kinesis Client Library for Python to write their data processing applications.

Release 1.1 (June 30, 2014)

  • Checkpointing at a specific sequence number — The IRecordProcessorCheckpointer interface now supports checkpointing at a sequence number specified by the record processor.
  • Set region — KinesisClientLibConfiguration now supports setting the region name to indicate the location of the Amazon Kinesis service. The Amazon DynamoDB table and Amazon CloudWatch metrics associated with your application will also use this region setting.