Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bimedia-fr/architect-kafka
https://github.com/bimedia-fr/architect-kafka
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/bimedia-fr/architect-kafka
- Owner: bimedia-fr
- License: apache-2.0
- Created: 2016-09-05T08:35:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-11-19T14:09:58.000Z (about 3 years ago)
- Last Synced: 2024-12-07T20:18:05.814Z (about 1 month ago)
- Language: JavaScript
- Size: 86.9 KB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# architect-kafka [](https://www.npmjs.com/package/architect-kafka)
Expose [kafka-node](https://github.com/SOHU-Co/kafka-node) as architect plugin
### Installation
```sh
npm install --save architect-kafka
```
### Usage
Boot [Architect](https://github.com/c9/architect) :
```js
var path = require('path');
var architect = require("architect");
var configPath = path.join(__dirname, "config.js");
var config = architect.loadConfig(configPath);
architect.createApp(config, function (err, app) {
if (err) {
throw err;
}
console.log("app ready");
});
```
Configure Architect with `config.js` :
See [kafka-node documentation](https://github.com/SOHU-Co/kafka-node#kafkaClient) for Client options
See [kafka-node documentation](https://github.com/SOHU-Co/kafka-node#consumer) for Consumer options
See [kafka-node documentation](https://github.com/SOHU-Co/kafka-node#producer) for Producer options
```js
module.exports = [
{
packagePath: 'architect-kafka',
client: { // Optional, default client. See Kafka-Client for options https://www.npmjs.com/package/kafka-node/v/3.0.1#kafkaclient
kafkaHost : 'localhost:9092', // Default localhost:9092
connectTimeout : 10000, // default: 10000
requestTimeout : 30000, // default: 30000
autoConnect : true, // default: true
idleConnection : 300000, // default: 5 minutes
maxAsyncRequests : 10, // default: 10,
sslOptions: { rejectUnauthorized: false }
},
consumers: {
// Create a HighLevelConsumer using custom client, consuming from topics topicName1 and topicName2
consumer1: {
// Consumer type [HighLevel|ConsumerGroup], optional default to Consumer
type: HighLevel,
// See kafka-node documentation for Client options
client: {
kafkaHost: 'localhost:9092'
},
// See kafka-node documentation for Consumer options
payloads: [
{
topic: 'topicName1',
offset: 0
},
{
topic: 'topicName2',
offset: 10
}
],
options: {
groupId: 'kafka-node-group'
}
},
// Create Consumer using default client
consumer2: {
payloads: [
{
topic: 'topicName1',
offset: 0
}
],
options: {}
}
},
producers: {
// Create a HighLevelProducer using custom client
producer1: {
highLevel: true, // Use HighLevelproducer instead of Producer, default false
client: { // See Kafka-Client for options https://www.npmjs.com/package/kafka-node/v/3.0.1#kafkaclient
kafkaHost: 'localhost:9092'
},
// See kafka-node documentation for Producer options
options: {}
},
// Create a regular Kafka Producer using default client
producer2: {}
}
}
];
```
Use it :
See [kafka-node documentation](https://github.com/SOHU-Co/kafka-node#consumer) for Consumer usage
See [kafka-node documentation](https://github.com/SOHU-Co/kafka-node#producer) for Producer usage
```js
module.exports = function setup(options, imports, register) {
var kafka = imports.kafka;
var producer1 = kafka.producers.producer1;
var consumer2 = kafka.consumers.consumer2;
producer1.send([
{
topic: 'topicName1',
message: ['hello world !']
}
], function(err, res) {
...
});
consumer2.on('message', function(message) {
...
});
register();
};
module.exports.consumes = ['kafka'];
module.exports.provides = [];
```