Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mhart/kinesalite
An implementation of Amazon's Kinesis built on LevelDB
https://github.com/mhart/kinesalite
Last synced: 1 day ago
JSON representation
An implementation of Amazon's Kinesis built on LevelDB
- Host: GitHub
- URL: https://github.com/mhart/kinesalite
- Owner: mhart
- License: mit
- Created: 2013-11-14T22:29:38.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-23T11:42:42.000Z (8 months ago)
- Last Synced: 2024-10-29T21:13:07.994Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 448 KB
- Stars: 809
- Watchers: 22
- Forks: 86
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Kinesalite
----------
[](http://travis-ci.org/mhart/kinesalite)
An implementation of [Amazon's Kinesis](http://docs.aws.amazon.com/kinesis/latest/APIReference/),
focussed1 on correctness and performance, and built on LevelDB
(well, [@rvagg](https://github.com/rvagg)'s awesome [LevelUP](https://github.com/rvagg/node-levelup) to be precise).
The Kinesis equivalent of [dynalite](https://github.com/mhart/dynalite).
To read and write from Kinesis streams in Node.js, consider using the [kinesis](https://github.com/mhart/kinesis)
module.
Example
-------
```sh
$ kinesalite --help
Usage: kinesalite [--port ] [--path ] [--ssl] [options]
A Kinesis http server, optionally backed by LevelDB
Options:
--help Display this help message and exit
--port The port to listen on (default: 4567)
--path The path to use for the LevelDB store (in-memory by default)
--ssl Enable SSL for the web server (default: false)
--createStreamMs Amount of time streams stay in CREATING state (default: 500)
--deleteStreamMs Amount of time streams stay in DELETING state (default: 500)
--updateStreamMs Amount of time streams stay in UPDATING state (default: 500)
--shardLimit Shard limit for error reporting (default: 10)
Report bugs at github.com/mhart/kinesalite/issues
```
Or programmatically:
```js
// Returns a standard Node.js HTTP server
var kinesalite = require('kinesalite'),
kinesaliteServer = kinesalite({path: './mydb', createStreamMs: 50})
// Listen on port 4567
kinesaliteServer.listen(4567, function(err) {
if (err) throw err
console.log('Kinesalite started on port 4567')
})
```
Once running, here's how you use the [AWS SDK](https://github.com/aws/aws-sdk-js) to connect
(after [configuring the SDK](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html)):
```js
var AWS = require('aws-sdk')
var kinesis = new AWS.Kinesis({endpoint: 'http://localhost:4567'})
kinesis.listStreams(console.log.bind(console))
```
Or with the [kinesis](https://github.com/mhart/kinesis) module (currently only works in https mode, when kinesalite is started with `--ssl`):
```js
var kinesis = require('kinesis')
kinesis.listStreams({host: 'localhost', port: 4567}, console.log)
```
Installation
------------
With [npm](http://npmjs.org/) do:
```sh
$ npm install -g kinesalite
```
Footnotes
---------
1Hi! You're probably American ([and not a New Yorker editor](https://www.newyorker.com/books/page-turner/the-double-l)) if you're worried about this spelling. No worries –
and no need to open a pull request – we have different spellings in the rest of the English speaking world 🐨