@pacmard/winston-kafka-transport

Flexible and simple kafka transport for winston v3

Usage no npm install needed!

<script type="module">
  import pacmardWinstonKafkaTransport from 'https://cdn.skypack.dev/@pacmard/winston-kafka-transport';
</script>

README

Kafka transport for Winston v3

NPM

Installment

Requires winston v3

npm install @pacmard/winston-kafka-transport --save

Or yarn

yarn add @pacmard/winston-kafka-transport

How to use

const winston = require('winston');
const KafkaTransport = require('@pacmard/winston-kafka-transport');

winston.add(
  new KafkaTransport({
    level: 'info',
    format: format.combine(...traceFormats),
    meta: {},
    kafkaOptions: {
      brokers: ['localhost:9092'],
      clientId: 'winston-kafka-logger',
    },
    topic: kafkaTopic,
    name: 'WinstonLogs',
    formatter: JSON.stringify,
  }),
);

Configuration

More flexible configuration for kafka brokers can be done in kafkaOptions parameter of transport.

Detailed description is available at kafka.js docs https://kafka.js.org/docs/introduction

License

Apache-2.0