https://github.com/fastify/fastify-kafka

Fastify plugin to interact with Apache Kafka.
https://github.com/fastify/fastify-kafka

event-sourcing events fastify fastify-plugin kafka

Last synced: about 21 hours ago
JSON representation

Fastify plugin to interact with Apache Kafka.

• Host: GitHub
• URL: https://github.com/fastify/fastify-kafka
• Owner: fastify
• License: mit
• Created: 2017-11-03T13:16:58.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-12-09T11:28:23.000Z (13 days ago)
• Last Synced: 2024-12-14T17:05:31.480Z (8 days ago)
• Topics: event-sourcing, events, fastify, fastify-plugin, kafka
• Language: JavaScript
• Homepage:
• Size: 102 KB
• Stars: 55
• Watchers: 19
• Forks: 19
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @fastify/kafka

[![CI](https://github.com/fastify/fastify-kafka/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/fastify/fastify-kafka/actions/workflows/ci.yml)

[![NPM version](https://img.shields.io/npm/v/@fastify/kafka.svg?style=flat)](https://www.npmjs.com/package/@fastify/kafka)

[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)

Fastify plugin to interact with [Apache Kafka](http://kafka.apache.org/). Supports Kafka producer and consumer.

To achieve the best performance, the plugin uses [`node-rdkafka`](https://github.com/Blizzard/node-rdkafka).

### Install

```

npm i @fastify/kafka

```

### Usage

```js

const crypto = require('node:crypto')

const fastify = require('fastify')()

const group = crypto.randomBytes(20).toString('hex')

fastify

  .register(require('@fastify/kafka'), {

    producer: {

      'metadata.broker.list': '127.0.0.1:9092',

      'fetch.wait.max.ms': 10,

      'fetch.error.backoff.ms': 50,

      'dr_cb': true

    },

    consumer: {

      'metadata.broker.list': '127.0.0.1:9092',

      'group.id': group,

      'fetch.wait.max.ms': 10,

      'fetch.error.backoff.ms': 50,

      'auto.offset.reset': 'earliest'

    }

  })

fastify.post('/data', (req, reply) => {

  fastify.kafka.push({

    topic: 'updates',

    payload: req.body,

    key: 'dataKey'

  })

})

fastify.kafka.subscribe('updates')

fastify.kafka.on('updates', (msg, commit) => {

  console.log(msg.value.toString())

  commit()

})

fastify.listen({ port: 3000 }, err => {

  if (err) throw err

  console.log(`server listening on ${fastify.server.address().port}`)

})

 ```

For more examples on how to use this plugin you can take a look at the [examples directory](./examples).

### API

This module exposes the following APIs:

##### Producer

- `fastify.kafka.producer`: the producer instance

- `fastify.kafka.push`: utility to produce a new message

##### Consumer

- `fastify.kafka.consumer`: the consumer instance

- `fastify.kafka.consume`: utility to start the message consuming

- `fastify.kafka.subscribe`: utility to start the subscribe to one or more topics

- `fastify.kafka.on`: topic listener

## Acknowledgements

This project is kindly sponsored by:

- [LetzDoIt](https://www.letzdoitapp.com/)

## License

Licensed under [MIT](./LICENSE).