Skip to main content

Producer for AWS Kinesis Stream with record aggregation

Project description

Python producer for AWS Kinesis Stream with record aggregation.

It uses Boto 3 and is tested on Python 2.7 and 3.4/3.5.

Install

pip install ‘kinesis_producer < 1’

Note: Kinesis Producer use semver: you should always freeze on the major version since it could mean breaking the API.

Usage

Send records aggregated up to 100KB, 200ms and joined with ‘\n’:

from kinesis_producer import KinesisProducer

config = dict(
    aws_region='us-east-1',
    buffer_size_limit=100000,
    buffer_time_limit=0.2,
    kinesis_concurrency=1,
    kinesis_max_retries=10,
    record_delimiter='\n',
    stream_name='KINESIS_STREAM_NAME',
    )

k = KinesisProducer(config=config)

for record in records:
    k.send(record)

k.close()
k.join()

Config

aws_region:

AWS region for Kinesis calls (like us-east-1)

buffer_size_limit:

Approximative size limit for record aggregation (in bytes)

buffer_time_limit:

Approximative time limit for record aggregation (in seconds)

kinesis_concurrency:

Set the concurrency level for Kinesis calls. Set to 1 for no concurrency. Set to 2 and more to use a thread pool.

kinesis_max_retries:

Number of Kinesis put_records call attempt before giving up. This number should be between 4 and 10 if you want to handle temporary ProvisionedThroughputExceeded errors.

record_delimiter:

Delimiter for record aggregation

stream_name:

Name of the Kinesis Stream

Kinesis retries

Kinesis calls are retried for ProvisionedThroughputExceeded error only. Retry use an exponential backoff logic (0.1s, 0.2s, 0.4s, 0.8s, 1.60s, 3.20s, 6.40s, 12.80s, 25.60s, 51.20s, 102.40s…)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kinesis_producer-0.2.1.tar.gz (6.4 kB view details)

Uploaded Source

File details

Details for the file kinesis_producer-0.2.1.tar.gz.

File metadata

File hashes

Hashes for kinesis_producer-0.2.1.tar.gz
Algorithm Hash digest
SHA256 fbd819e802421a88537812c0dae170d2ebdfd12277af03b3ec51fd74a8b6c07a
MD5 8be046a713ba40eef9734ced2d7cbc2c
BLAKE2b-256 80466dbba56b6f038e90246b926fd01f384e5fbea3c32a048597c6f2e1d44611

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page