npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

kinesiserapy

v0.0.4

Published

AWS Kinesis stream consumer and producer

Downloads

3

Readme

Kinesiserapy: a AWS Kinesis event stream interface

This module provides an AWS Kinesis event stream consumer and emitter implementations.

Configuration

AWS credentials and a stream name must be provided to connect to Kinesis. The credentials are passed in an object that must have the following keys

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • AWS_REGION

The stream name is simply a string.

Emit an event

var kinesiserapy = require('kinesiserapy');

var kinesisAuth = {
    AWS_ACCESS_KEY_ID: "the key id",
    AWS_SECRET_ACCESS_KEY: "the access key",
    AWS_REGION: "the region"
};
var stream = "my-stream";
var emitter = new kinesiserapy.KEmitter(stream,kinesisAuth);

emitter.emit(
    {
        "key": "value"
    },
    function(err) {
        if (err) {
            console.error(err);
        } else {
            console.log('event emitted');
        }
    });

Consuming from a stream

The easiest way to consumer from a stream is to list the shards and spawn a new process to consume from each shard.

var cluster = require('cluster');
var kinesiserapy = require('kinesiserapy');

var kinesisAuth = {
    AWS_ACCESS_KEY_ID: "the key id",
    AWS_SECRET_ACCESS_KEY: "the access key",
    AWS_REGION: "the region"
};
var stream = "my-stream";

if (cluster.isMaster) {
	var kinfo = new kinesiserapy.KInfo(stream, kinesisAuth);
	kinfo.listShards(function(err, shardIds) {
		if (err) {
			console.error(err);
		} else {
			shardIds.forEach(function (shardId, index, shardIds) {
				cluster.fork({stream: stream, shardId: shardId});
			});
		}
	});
} else if (cluster.isWorker) {
	var kConsumer = new kinesiserapy.KConsumer(
		process.env.stream,
		process.env.shardId,
		lambda,
		function(err) {
			console.error(err)
		},
		kinesisAuth);
	kConsumer.consume();
}

function lambda(data) {
    console.log(data);
}

API

kinesiserapy exposes three objects:

  • KInfo to obtain information about the stream
    • listShards(callback) where callback is a fn(err, shardIds). The callback function is called with err null and shardIds being an array of string. If an error occurred, err is not null.
  • KConsumer to consume from a shard
    • consume() starts an asynchronous consumer that loops
  • KEmitter to emit an event
    • emit(obj, cb) emits the object obj and calls the callback cb after the event is emitted.
      The callback has the signature cb(err, data).
      • err is null unless an error occurred.
      • data contains two keys:
        • SequenceNumber: the sequence number of the emitted event
        • ShardId: the shard on which the event was emitted