Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.25 KB

README.md

File metadata and controls

34 lines (27 loc) · 1.25 KB
Raw

Kafka-SSE-proxy

Description

This is a simple webserver which exposes a kafka topic as server sent events. In order to keep access control concerns limited, the topic is set as configuration and cannot be set by the client.

A single server sent events stream maps onto a kafka topic partition. Clients can discover the available partitions through a dedicated endpoint. In future versions we might add query parameters to this, so that clients can only subscribe to the partitions which make sense given the partitioning scheme used by kafka for this topic.

Configuration

  • PORT: The port on which the http server will bind (default: 80)
  • BROKERS: A list of kafka endpoints to try when connecting to the kafka cluster (default: localhost:9092)
  • TOPIC: The topic to stream events off (default: test)
  • LOGGING_LEVEL: The verbosity of the server logging (default: info, anyOf: [trace, debug, info, warn, error, fatal])

Build

Using docker

docker build .

Native

npm install
npm start

A docker-compose.yml file with a test kafka cluster is provided in the repository as well

docker-compose up -d zookeeper kafka
npm install
PORT=12345 BROKERS=localhost:9094 TOPIC=test npm start