Skip to content

Latest commit

 

History

History
512 lines (455 loc) · 41.2 KB

CHANGELOG.md

File metadata and controls

512 lines (455 loc) · 41.2 KB
Raw

Changelog

Release 2.2.0 (April 8, 2019)

Milestone#31

  • Updated License to Apache License 2.0
  • Introducing configuration for suppressing logs from ReadTimeoutExceptions caused while calling SubscribeToShard.
    Suppression can be configured by setting LifecycleConfig#readTimeoutsToIgnoreBeforeWarning(Count).

Release 2.1.3 (March 18, 2019)

Milestone#30

  • Added a message to recommend using KinesisClientUtil when an acquire timeout occurs in the FanOutRecordsPublisher.
  • Added a sleep between retries while waiting for a newly created stream consumer to become active.
  • Added timeouts on all futures returned from the DynamoDB and Kinesis clients.
    The timeouts can be configured by setting LeaseManagementConfig#requestTimeout(Duration) for DynamoDB, and PollingConfig#kinesisRequestTimeout(Duration) for Kinesis.
  • Upgraded to SDK version 2.5.10.
  • Artifacts for the Amazon Kinesis Client for Java are now signed by a new GPG key: 
    pub   4096R/86368934 2019-02-14 [expires: 2020-02-14]
uid                  Amazon Kinesis Tools <[email protected]>

Release 2.1.2 (February 18, 2019)

Milestone#29

  • Fixed handling of the progress detection in the ShardConsumer to restart from the last accepted record, instead of the last queued record.
  • Fixed handling of exceptions when using polling so that it will no longer treat SdkExceptions as an unexpected exception.
  • Fixed a case where lease loss would block the Scheduler while waiting for a record processor's processRecords method to complete.

Release 2.1.1 (February 6, 2019)

Milestone#28

  • Introducing SHUT_DOWN_STARTED state for the WorkerStateChangeListener.
  • Fixed a bug with AWSSessionCredentials using AWSSecretID instead of AWSAccessID and vice versa.
  • Upgrading SDK version to 2.4.0, which includes a fix for a possible deadlock when using Enhanced Fan-Out.

Release 2.1.0 (January 14, 2019)

Milestone #27

  • Introducing MultiLangDaemon support for Enhanced Fan-Out.
  • MultiLangDaemon now supports the following command line options.
    • --properties-file: Properties file that the KCL should use to set up the Scheduler.
    • --log-configuration: logback.xml that the KCL should use for logging.
  • Updated AWS SDK dependency to 2.2.0.
  • MultiLangDaemon now uses logback for logging.

Release 2.0.5 (November 12, 2018)

Milestone #26

  • Fixed a deadlock condition that could occur when using the polling model.
    When using the PollingConfig and a slower record processor it was possible to hit a deadlock in the retrieval of records.
  • Adjusted RetrievalConfig, and FanOutConfig to use accessors instead of direct member access.

Release 2.0.4 (October 18, 2018)

Milestone #25

  • Added method to retrieve leases from the LeaseCoordinator and LeaseTaker.
  • Fixed a race condition shutting down the Scheduler before it has completed initialization.
  • Added HierarchicalShardSyncer which replaces the static ShardSyncer.
    HierarchicalShardSyncer removes the contention between multiple instances of the Scheduler when running under a single JVM.
  • Added TaskExecutionListener which allows monitoring of tasks being executed by the ShardConsumer.
    The listener is invoked before and after a task is executed by the ShardConsumer.

Release 2.0.3 (October 8, 2018)

Milestone #23

  • Fixed an issue where the KinesisAsyncClient could be misconfigured to use HTTP 1.1.
    Using HTTP 1.1 with SubscribeToShard is unsupported, and could cause misdelivery of records to the record processor.
  • Lower the severity of ReadTimeout exceptions.
    ReadTimeout exceptions can occur if the client is unable to request data from Kinesis for more than client timeout, which defaults to 30 seconds. This can occur if the record processor blocks for more than the timeout period. ReadTimeout could also occur as part of Issue #391.
  • Added a callback that allows applications to take actions after DynamoDB table creation.
    Applications can now install a callback that is called after creating the DynamoDB table by implementing TableCreatorCallback.
  • Updated the guava dependency to 26.0-jre.
  • Added some additional debug logging around the initialization of the FanOutRecordsPublisher.
  • Upgraded AWS SDK version to 2.0.6

Release 2.0.2 (September 4, 2018)

Milestone #22

  • Fixed an issue where the a warning would be logged every second if logWarningForTaskAfterMillis was set.
    The logging for last time of data arrival now respects the value of logWarningForTaskAfterMillis.
  • Moved creation of WorkerStateChangedListener and GracefulShutdownCoordinator to the CoordinatorConfig. Originally the WorkerStateChangedListener and GracefulShutdownCoordinator were created by methods on the SchedulerCoordinatorFactory, but they should have been configuration options.
    The original methods have been deprecated, and may be removed at a later date.
  • Removed dependency on Apache Commons Lang 2.6.
    The dependency on Apache Commons Lang 2.6 has removed, and all usages updated to use Apache Commons Lang 3.7.
  • Fixed a typo in the MutliLang Daemon shutdown hook.
  • Added method onAllInitializationAttemptsFailed(Throwable) to WorkerStateChangedListener to report when all initialization attempts have failed.
    This method is a default method, and it isn't require to implement the method. This method is only called after all attempts to initialize the Scheduler have failed.

Release 2.0.1 (August 21, 2018)

  • Mark certain internal components with @KinesisClientInternalApi attribute.
    Components marked as internal may be deprecated at a faster rate than public components.
  • Fixed an issue where ResourceNotFoundException on subscription to a shard was not triggering end of shard handling.
    If a lease table contains a shard that is no longer present in the stream attempt to subscribe to that shard will trigger a ResourceNotFoundException. These exception are treated the same as reaching the end of a shard.
  • Fixed an issue where the KCL would not Use the configured DynamoDB IOPs when creating the lease table.
  • Make the maximum number of Scheduler initialization attempts configurable.
    The maximum number of Scheduler initialization attempts can be configured via CoordinatorConfig#maxInitializationAttempts.
  • Fixed an issue where it was possible to get a duplicate record when resubscribing to a shard.
    Subscribe to shard requires periodic resubscribing, and uses a new concept of a continuation sequence number. If the continuation sequence number was equal to the last record that record would be processed a second time. Resubscribing now uses AFTER_SEQUENCE_NUMBER to ensure that only later records are returned.
  • Upgraded to AWS SDK 2.0.1
  • Fixed an issue where time based restart of the subscription wasn't resetting the lastRequestTime.
    If a subscription hasn't delivered any data for more than 30 seconds it will be canceled and restarted. This detection is based of the lastRequestTime which wasn't getting reset after the restart was triggered.
  • Fixed an issue where requesting on the subscription from the FanOutRecordsPublisher could trigger an unexpected failure.
    Due to a race condition the underlying flow in the subscription could be set to something else. The method is now synchronized, and verifies that the subscriber it was created with is still the subscriber in affect.
    This issue generally would only appear when multiple errors were occurring while connecting to Kinesis.
  • Fixed an issue where the number of requested items could exceed the capacity of the RxJava queue.
    There was an off by one issue when determining whether to make a request to the SDK subscription. This changes the calculation to represent the capacity as a queue.

Release 2.0.0 (August 02, 2018)

  • The Maven groupId, along with the version, for the Amazon Kinesis Client has changed from com.amazonaws to software.amazon.kinesis.
    To add a dependency on the new version of the Amazon Kinesis Client:

    <dependency>
    <groupId>software.amazon.kinesis</groupId>
    <artifactId>amazon-kinesis-client</artifactId>
    <version>2.0.0</version>
</dependency>

  • Added support for Enhanced Fan Out.
    Enhanced Fan Out provides for lower end to end latency, and increased number of consumers per stream.

    • Records are now delivered via streaming, reducing end-to-end latency.
    • The Amazon Kinesis Client will automatically register a new consumer if required.
      When registering a new consumer, the Kinesis Client will default to the application name unless configured otherwise.
    • SubscribeToShard maintains long lived connections with Kinesis, which in the AWS Java SDK 2.0 is limited by default.
      The KinesisClientUtil has been added to assist configuring the maxConcurrency of the KinesisAsyncClient.
      WARNING: The Amazon Kinesis Client may see significantly increased latency, unless the KinesisAsyncClient is configured to have a maxConcurrency high enough to allow all leases plus additional usages of the KinesisAsyncClient.
    • The Amazon Kinesis Client now uses 3 additional Kinesis API's:
      WARNING: If using a restrictive Kinesis IAM policy you may need to add the following API methods to the policy.
    • New configuration options are available to configure Enhanced Fan Out.
    Name Default Description
    consumerArn Unset The ARN for an already created consumer. If this is set, the Kinesis Client will not attempt to create a consumer.
    streamName Unset The name of the stream that a consumer should be create for if necessary
    consumerName Unset The name of the consumer to create. If this is not set the applicationName will be used instead.
    applicationName Unset The name of the application. This is used as the name of the consumer unless consumerName is set.

  • Modular Configuration of the Kinesis Client The Kinesis Client has migrated to a modular configuration system, and the KinesisClientLibConfiguration class has been removed.
    Configuration has been split into 7 classes. Default versions of the configuration can be created from the ConfigsBuilder.
    Please [see the migration guide for more information][migration-guide].

    • CheckpointConfig
    • CoordinatorConfig
    • LeaseManagementConfig
    • LifecycleConfig
    • MetricsConfig
    • ProcessorConfig
    • RetrievalConfig

  • Upgraded to AWS Java SDK 2.0
    The Kinesis Client now uses the AWS Java SDK 2.0. The dependency on AWS Java SDK 1.11 has been removed. All configurations will only accept 2.0 clients.

    • When configuring the KinesisAsyncClient the KinesisClientUtil#createKinesisAsyncClient can be used to configure the Kinesis Client
    • If you need support for AWS Java SDK 1.11 you will need to add a direct dependency.
      When adding a dependency you must ensure that the 1.11 versions of Jackson dependencies are excluded
      [Please see the migration guide for more information][migration-guide]

  • MultiLangDaemon is now a separate module
    The MultiLangDaemon has been separated to its own Maven module and is no longer available in amazon-kinesis-client. To include the MultiLangDaemon, add a dependency on amazon-kinesis-client-multilang.

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)

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.