Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nodefluent/kafka-connect
equivalent to kafka-connect :wrench: for nodejs :sparkles::turtle::rocket::sparkles:
https://github.com/nodefluent/kafka-connect
connect datastore etl framework kafka kafka-connect nodejs
Last synced: 3 days ago
JSON representation
equivalent to kafka-connect :wrench: for nodejs :sparkles::turtle::rocket::sparkles:
- Host: GitHub
- URL: https://github.com/nodefluent/kafka-connect
- Owner: nodefluent
- License: mit
- Created: 2017-05-13T19:07:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T17:20:13.000Z (about 2 years ago)
- Last Synced: 2024-04-14T21:54:23.044Z (10 months ago)
- Topics: connect, datastore, etl, framework, kafka, kafka-connect, nodejs
- Language: JavaScript
- Homepage:
- Size: 679 KB
- Stars: 127
- Watchers: 7
- Forks: 8
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kafka - Node Kafka connect
README
# node-kafka-connect
[](https://travis-ci.org/nodefluent/kafka-connect)
[](https://coveralls.io/github/nodefluent/kafka-connect?branch=master)
## What can I do with this?
The framework can be used to build connectors,
that transfer data `to` and `from` Apache Kafka and Databases,
very easily. If you are looking for already implemented connectors
for you favorite datastore, take a look at the `Available Connector Implementations` below.
## Info
- node-kafka-connect is a framework to implement large
`kafka -> datastore` & `datastore -> kafka` data movements.
- it can be used to easily built connectors from/to kafka to any kind of
datastore/database.
- a connector might consist of a SourceConnector + SourceTask to
poll data from a datastore into a kafka topic.
- a connector might consist of a SinkConnector + SinkTask to put
data from a kafka topic into a datastore.
- Converters might be used to apply alteration to any data-stream.
- any operation in node-kafka-connect is asynchronous
- ships with auto http server (health-checks, kafka-stats)
- ships with auto metrics (prometheus)
## A note on native mode
If you are using the native mode (`config: { noptions: {} }`).
You will have to manually install `node-rdkafka` alongside kafka-connect.
(This requires a Node.js version between 9 and 12 and will not work with Node.js >= 13, last tested with 12.16.1)
On Mac OS High Sierra / Mojave:
`CPPFLAGS=-I/usr/local/opt/openssl/include LDFLAGS=-L/usr/local/opt/openssl/lib yarn add --frozen-lockfile [email protected]`
Otherwise:
`yarn add --frozen-lockfile [email protected]`
(Please also note: Doing this with npm does not work, it will remove your deps, `npm i -g yarn`)
## Available Connector Implementations
* [Sequelize (MySQL, Postgres, SQLite, MSSQL)](https://github.com/nodefluent/sequelize-kafka-connect)
* [Google BigQuery](https://github.com/nodefluent/bigquery-kafka-connect)
* [Salesforce](https://github.com/nodefluent/salesforce-kafka-connect)
* [Google PubSub](https://github.com/nodefluent/gcloud-pubsub-kafka-connect)
## Creating custom Connectors
```
yarn add kafka-connect
```
```es6
const source = new TestSourceConfig(config,
TestSourceConnector,
TestSourceTask,
[TestConverter]);
source.run().then();
```
```es6
const sink = new TestSinkConfig(config,
TestSinkConnector,
TestSinkTask,
[TestConverter]);
sink.run().then();
```
## Docs
* [Implementation-Helper Overview](docs/sample.md)
* [Framework Events](docs/events.md)
## Debugging
* You can use `DEBUG=kafka-connect:*` to debug the sink configuration.
## FAQ
* Q: it is running slow / only synchronous / 1 by 1 messages ?
* A: just set the config.batch object [as it is described here](https://github.com/nodefluent/node-sinek/tree/master/lib/librdkafka#advanced-1n-consumer-mode)