@mia-platform/kafkajs-pino-logger

A custom Pino logger for KafkaJS that follows the Mia-Platform guidelines'

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@mia-platform/kafkajs-pino-logger
691.0.02 years ago2 years agoMinified + gzip package size for @mia-platform/kafkajs-pino-logger in KB

Readme

KafkaJS pino logger
javascript style guide

This library provides a pino custom logger for KafkaJS that follows Mia-Platform guidelines for logs

Getting Started

Install

The package require kafkajs to work, to list the correct version you can run:
npm info "@mia-platform/kafkajs-pino-logger@latest" peerDependencies

To install the package you can run:
npm install @mia-platform/kafkajs-pino-logger --save

How to use it

The package exposes a log creator that you can pass to the logCreator option when configuring your Kafka client.
const { Kafka } = require('kafkajs')
const PinoLogCreator = require('@mia-platform/kafkajs-pino-logger')

const kafka = new Kafka({
  clientId: 'my-app',
  brokers: ['kafka1:9092', 'kafka2:9092'],
  logLevel: logLevel.ERROR,
  logCreator: PinoLogCreator
})

Output logs

The logs will have this form:
{"level":20,"time":1610718695,"pid":46244,"hostname":"test-host","logger":"kafkajs","extraKey":"Your extra","msg":"Your log message"}