Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redclawtech/vernemq_kinesis
VerneMQ plugin that aggregates and sends MQTT messages to AWS Kinesis.
https://github.com/redclawtech/vernemq_kinesis
aws erlang iot kinesis-stream mqtt vernemq vernemq-plugins
Last synced: about 2 months ago
JSON representation
VerneMQ plugin that aggregates and sends MQTT messages to AWS Kinesis.
- Host: GitHub
- URL: https://github.com/redclawtech/vernemq_kinesis
- Owner: redclawtech
- License: apache-2.0
- Created: 2017-11-22T01:19:29.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-23T19:18:25.000Z (almost 7 years ago)
- Last Synced: 2024-05-20T03:18:52.830Z (7 months ago)
- Topics: aws, erlang, iot, kinesis-stream, mqtt, vernemq, vernemq-plugins
- Language: Erlang
- Homepage:
- Size: 17.6 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- cuban-opensource - vernemq_kinesis
README
# VerneMQ Kinesis Plugin
This is a [VerneMQ](https://vernemq.com/) plugin that aggregates and sends MQTT messages to
[AWS Kinesis](https://aws.amazon.com/kinesis/).
## Prerequisites
* A recent version of Erlang OTP(19 recommended).
## How to compile this plugin
This project uses [Rebar3](https://www.rebar3.org) as a build tool and can be compiled running:
```bash
rebar3 compile
```
## How to enable the plugin on VerneMQ
### Manually enable
```console
vmq-admin plugin enable --name=vernemq_kinesis --path=/vernemq_kinesis/_build/default/lib/vernemq_kinesis
```
### Permanently enable (On VerneMQ start)
Add the following to the `vernemq.conf` file.
```erlang
plugins.vernemq_kinesis = on
plugins.vernemq_kinesis.path = /vernemq_kinesis/_build/default/lib/vernemq_kinesis
```
## Configuration
The following settings are available for this plugin:
* **vernemq_kinesis.aws_key**: The AWS Key. See http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html.
* **vernemq_kinesis.aws_secret_key**: The AWS secret key for connecting to Kinesis. See http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html.
* **vernemq_kinesis.region**: The AWS region.
* **vernemq_kinesis.stream**: The Kinesis stream name to write to.
* **vernemq_kinesis.allowed_topics**: The topics that are allowed to publish to Kinesis. Can use "#" for all the topics or wilcards like <<"devices/#">>. Defaults to "#".
* **vernemq_kinesis.batch_size**: The number of records to batch before flushing the queue.
Defaults to 500.
* **vernemq_kinesis.batch_time**: The maximum of milliseconds to wait before flushing the queue. Defaults to 20000(20 seconds).
They can be added to the `vernemq.conf` file.