https://github.com/sneako/ex_kpl

Elixir Kinesis Producer Library Record Aggregator
https://github.com/sneako/ex_kpl

aggregator elixir kinesis kpl

Last synced: 7 months ago
JSON representation

Elixir Kinesis Producer Library Record Aggregator

• Host: GitHub
• URL: https://github.com/sneako/ex_kpl
• Owner: sneako
• License: mit
• Created: 2018-01-31T00:43:17.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-04-19T14:56:38.000Z (over 4 years ago)
• Last Synced: 2025-03-18T18:43:38.849Z (7 months ago)
• Topics: aggregator, elixir, kinesis, kpl
• Language: Elixir
• Homepage:
• Size: 34.2 KB
• Stars: 10
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ExKpl [![Coverage Status](https://coveralls.io/repos/github/sneako/ex_kpl/badge.svg?branch=master)](https://coveralls.io/github/sneako/ex_kpl?branch=master) [![Build Status](https://travis-ci.org/sneako/ex_kpl.svg?branch=master)](https://travis-ci.org/sneako/ex_kpl)

[Kinesis Producer Library](https://docs.aws.amazon.com/streams/latest/dev/developing-producers-with-kpl.html) in Elixir

This module provides record aggregation similar to Amazon's KPL library.

Once the records are aggregated you can use your preferred method of sending them to Kinesis, [ex_aws](https://github.com/ex-aws/ex_aws_kinesis) for example.

## Documentation

Available on [hex](https://hexdocs.pm/ex_kpl/api-reference.html)

## Installation

The package can be installed

by adding `ex_kpl` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:ex_kpl, "~> 0.2"}

  ]

end

```

This library depends on [protox](https://github.com/ahamez/protox), which has a compile time dependency on Google's protoc (>= 3.0) to parse .proto files.

It must be available in $PATH. You can install it with your favorite package manager (brew install protobuf, apt install protobuf-compiler, etc...).

## Credits

This is basically a port of AdRoll's Erlang implementation included in [adroll/erlmld](https://github.com/AdRoll/erlmld), so a special thanks to them.