Client library for Amazon Kinesis
Find a file
Justin Pfifer c053789409 Use an explicit lock for shutdown instead of the general lock (#501)
If the Scheduler loses its lease for a shard it will attempt to
shutdown the ShardConsumer processing that shard.  When shutting down
the ShardConsumer acquires a lock on `this` and makes the necessary
state changes.

This becomes an issue if the ShardConsumer is currently processing a
batch of records as processing of the records is done under the
general `this` lock.

When these two things combine the Scheduler can become stuck waiting
on the record processing to complete.

To fix this the ShardConsumer will now use a specific lock on shutdown
state changes to prevent the Scheduler from becoming blocked.

Allow the shutdown state change future to acquire the lock

When the ShardConsumer is being shutdown we create a future for the
state change originally the future needed to acquire the lock before
attempting to create the future task.  This changes it to acquire the
lock while running on another thread, and complete the shutdown then.
2019-02-15 12:05:23 -08:00
.github Adding standard files (#302) 2018-02-26 10:31:55 -08:00
amazon-kinesis-client Use an explicit lock for shutdown instead of the general lock (#501) 2019-02-15 12:05:23 -08:00
amazon-kinesis-client-multilang Advance version to 2.1.2-SNAPSHOT (#496) 2019-02-07 07:59:37 -08:00
formatter Release 2.0.0 of the Amazon Kinesis Client for Java 2018-08-02 12:19:46 -07:00
META-INF Release 2.0.0 of the Amazon Kinesis Client for Java 2018-08-02 12:19:46 -07:00
.gitignore Fixing exception log messaging with Prefetching (#497) 2019-02-08 15:49:53 -08:00
.travis.yml Advance version, and drop Java 7 support (#176) 2017-07-20 12:03:34 -07:00
CHANGELOG.md Release 2.1.1 (#494) 2019-02-06 15:03:56 -08:00
CODE_OF_CONDUCT.md Adding standard files (#302) 2018-02-26 10:31:55 -08:00
CONTRIBUTING.md Adding standard files (#302) 2018-02-26 10:31:55 -08:00
LICENSE.txt 'Version 1.0.0 of the Amazon Kinesis Client Library' 2013-12-16 18:07:34 -08:00
NOTICE.txt Added Time Based Iterator Support 2016-08-11 09:20:25 -07:00
pom.xml Advance version to 2.1.2-SNAPSHOT (#496) 2019-02-07 07:59:37 -08:00
README.md Release 2.1.1 (#494) 2019-02-06 15:03:56 -08:00

Amazon Kinesis Client Library for Java

Build Status BuildStatus

The Amazon Kinesis Client Library for Java (Amazon KCL) enables Java developers to easily consume and process data from Amazon Kinesis.

⚠️ It's highly recommended for users of version 2.0 of the Amazon Kinesis Client to upgrade to version 2.0.3 or later. A bug has been identified in versions prior to 2.0.3 that could cause records to be delivered to the wrong record processor.

Amazon Kinesis Client versions 1.x are not impacted.

Please open an issue if you have any questions.

Features

  • Provides an easy-to-use programming model for processing data using Amazon Kinesis
  • Helps with scale-out and fault-tolerant processing

Getting Started

  1. Sign up for AWS — Before you begin, you need an AWS account. For more information about creating an AWS account and retrieving your AWS credentials, see AWS Account and Credentials in the AWS SDK for Java Developer Guide.
  2. Sign up for Amazon Kinesis — Go to the Amazon Kinesis console to sign up for the service and create an Amazon Kinesis stream. For more information, see Create an Amazon Kinesis Stream in the Amazon Kinesis Developer Guide.
  3. Minimum requirements — To use the Amazon Kinesis Client Library, you'll need Java 1.8+. For more information about Amazon Kinesis Client Library requirements, see Before You Begin in the Amazon Kinesis Developer Guide.
  4. Using the Amazon Kinesis Client Library — The best way to get familiar with the Amazon Kinesis Client Library is to read Developing Record Consumer Applications in the Amazon Kinesis Developer Guide.

Building from Source

After you've downloaded the code from GitHub, you can build it using Maven. To disable GPG signing in the build, use this command: mvn clean install -Dgpg.skip=true

Integration with the Kinesis Producer Library

For producer-side developers using the Kinesis Producer Library (KPL), the KCL integrates without additional effort. When the KCL retrieves an aggregated Amazon Kinesis record consisting of multiple KPL user records, it will automatically invoke the KPL to extract the individual user records before returning them to the user.

Amazon KCL support for other languages

To make it easier for developers to write record processors in other languages, we have implemented a Java based daemon, called MultiLangDaemon that does all the heavy lifting. Our approach has the daemon spawn a sub-process, which in turn runs the record processor, which can be written in any language. The MultiLangDaemon process and the record processor sub-process communicate with each other over STDIN and STDOUT using a defined protocol. There will be a one to one correspondence amongst record processors, child processes, and shards. For Python developers specifically, we have abstracted these implementation details away and expose an interface that enables you to focus on writing record processing logic in Python. This approach enables KCL to be language agnostic, while providing identical features and similar parallel processing model across all languages.

Using the KCL

The recommended way to use the KCL for Java is to consume it from Maven.

Version 2.x

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

Version 1.x

Version 1.x tracking branch

<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>amazon-kinesis-client</artifactId>
    <version>1.9.3</version>
</dependency>

Release Notes

Latest 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.

For remaining release notes check CHANGELOG.md.