winston3-kafka

A Winston 3 transport for logging to Apache Kafka.

Developed at AID:Tech.

Installation

Installation

npm install git+https://github.com/aidtechnology/winston3-kafka.git

Usage

var winston = require('winston');
winston.transports.Kafka = require('winston3-kafka');

var options = {
  topic: 'logs',
  clientOptions: {
      kafkaHost: {'localhost:9092'}  // We connect directly to Kafka, rather than Zookeeper
  }
};

winston.add(new winston.transports.Kafka(options));

Options

• topic - (required) Kafka topic
• clientOptions - node-kafka KafkaClient options
• producerOptions - node-kafka HighLevelProducer options
• compression - Compression to use on messages sent to Kafka (0: none [default], 1: Gzip, 2: Snappy)

Aknowledgements

This repository took inspiration from previous efforts to create a Winston transport for Kafka, namely:

https://github.com/bigdatr/winston-kafka-transport/blob/master/index.js https://github.com/Avocarrot/winston-kafka/blob/master/index.js