Client library for Amazon Kinesis
Find a file
2020-04-30 13:28:27 -07:00
.github Adding standard files (#302) 2018-02-26 10:31:55 -08:00
META-INF Release 1.9.1 of the Amazon Kinesis Client Library for Java (#337) 2018-04-30 13:18:41 -07:00
src Migrate KinesisProxy to ListShardsWithFilter for empty lease table case 2020-04-30 13:28:27 -07:00
.gitignore Added Unit, and Integration Tests 2016-07-20 12:58:43 -07:00
.travis.yml Advance version, and drop Java 7 support (#176) 2017-07-20 12:03:34 -07:00
CHANGELOG.md Prepare for KCL 1.13.3 release 2020-03-02 13:50:08 -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 Updating license to Apache License 2.0 (#522) 2019-04-05 16:08:24 -07:00
NOTICE.txt Added Time Based Iterator Support 2016-08-11 09:20:25 -07:00
pom.xml Post Release 1.13.3 2020-03-02 16:43:12 -08:00
README.md Prepare for KCL 1.13.3 release 2020-03-02 13:50:08 -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.

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.

Release Notes

Latest Release (1.13.3 March 2, 2020)

Release (1.13.2 Janurary 13, 2020)

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

Release (1.13.1 December 30, 2019)

  • 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)

  • Handling completed and blocked tasks better during graceful shutdown
For remaining release notes check CHANGELOG.md.