{"id":13410711,"url":"https://github.com/redclawtech/vernemq_kinesis","last_synced_at":"2025-03-14T16:32:57.570Z","repository":{"id":140924678,"uuid":"111620522","full_name":"redclawtech/vernemq_kinesis","owner":"redclawtech","description":"VerneMQ plugin that aggregates and sends MQTT messages to AWS Kinesis.","archived":false,"fork":false,"pushed_at":"2018-02-23T19:18:25.000Z","size":18,"stargazers_count":6,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-20T03:18:52.830Z","etag":null,"topics":["aws","erlang","iot","kinesis-stream","mqtt","vernemq","vernemq-plugins"],"latest_commit_sha":null,"homepage":"","language":"Erlang","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/redclawtech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-22T01:19:29.000Z","updated_at":"2024-07-30T22:51:54.372Z","dependencies_parsed_at":null,"dependency_job_id":"0d5db38e-1a3e-4530-92ef-58b4f8920f25","html_url":"https://github.com/redclawtech/vernemq_kinesis","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redclawtech%2Fvernemq_kinesis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redclawtech%2Fvernemq_kinesis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redclawtech%2Fvernemq_kinesis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redclawtech%2Fvernemq_kinesis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redclawtech","download_url":"https://codeload.github.com/redclawtech/vernemq_kinesis/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243610431,"owners_count":20318960,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","erlang","iot","kinesis-stream","mqtt","vernemq","vernemq-plugins"],"created_at":"2024-07-30T20:01:08.567Z","updated_at":"2025-03-14T16:32:57.143Z","avatar_url":"https://github.com/redclawtech.png","language":"Erlang","funding_links":[],"categories":["Internet of Things (IoT)"],"sub_categories":["Telegram"],"readme":"# VerneMQ Kinesis Plugin\n\nThis is a [VerneMQ](https://vernemq.com/) plugin that aggregates and sends MQTT messages to\n[AWS Kinesis](https://aws.amazon.com/kinesis/).\n\n## Prerequisites\n\n* A recent version of Erlang OTP(19 recommended).\n\n## How to compile this plugin\n\nThis project uses [Rebar3](https://www.rebar3.org) as a build tool and can be compiled running:\n\n```bash\nrebar3 compile\n```\n\n## How to enable the plugin on VerneMQ\n\n### Manually enable\n\n```console\nvmq-admin plugin enable --name=vernemq_kinesis --path=\u003cPathToYourPlugin\u003e/vernemq_kinesis/_build/default/lib/vernemq_kinesis\n```\n\n### Permanently enable (On VerneMQ start)\n\nAdd the following to the `vernemq.conf` file.\n\n```erlang\nplugins.vernemq_kinesis = on\nplugins.vernemq_kinesis.path = \u003cPathToYourPlugin\u003e/vernemq_kinesis/_build/default/lib/vernemq_kinesis\n```\n\n## Configuration\n\nThe following settings are available for this plugin:\n\n* **vernemq_kinesis.aws_key**: The AWS Key. See http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html.\n\n* **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.\n\n* **vernemq_kinesis.region**: The AWS region.\n\n* **vernemq_kinesis.stream**: The Kinesis stream name to write to.\n\n* **vernemq_kinesis.allowed_topics**: The topics that are allowed to publish to Kinesis. Can use \"#\" for all the topics or wilcards like \u003c\u003c\"devices/#\"\u003e\u003e. Defaults to \"#\".\n\n* **vernemq_kinesis.batch_size**: The number of records to batch before flushing the queue.\n        Defaults to 500.\n\n* **vernemq_kinesis.batch_time**: The maximum of milliseconds to wait before flushing the queue. Defaults to 20000(20 seconds).\n\nThey can be added to the `vernemq.conf` file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredclawtech%2Fvernemq_kinesis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredclawtech%2Fvernemq_kinesis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredclawtech%2Fvernemq_kinesis/lists"}