bunyan-elasticsearch-stream v1.5.0

bunyan-elasticsearch-stream

• A Bunyan stream for saving logs into Elasticsearch.
• Buffers logs in memory instead of sending them to the Elasticsearch server one by one.
• The logs are accumulated in memory until a certain number of logs reached or a certain amount of time passed without sending any logs.
• The goal is to save resources on both your application and Elastic Search server (ex: lowering costs in AWS).
• Written in Typescript.

Based on bunyan-elasticsearch-bulk

Requirements

• Elasticsearch 7.x
• Elasticsearch Data Stream.

Installation

npm i bunyan-elasticsearch-stream

Usage with Node

import bunyan from "bunyan";
import { BunyanESStream } from "bunyan-elasticsearch-stream";

const config = {
  name: 'Application Name',
  streams: [{
    level: 'debug',
    stream: new BunyanESStream({
      clientOptions: { node: "http://localhost:9200" },
    })
  }]
}

const log = bunyan.createLogger(config)

// From here, you can log things according to the best practices of Bunyan.
// Please familiarize yourself with it here: https://github.com/trentm/node-bunyan

log.info('Log this message!')
log.info({ otherInfo: 'What else do you need to log here?' }, 'Log this message!')

List of Configuration Parameters

Emitted Events

Check server.ts for example usages:

License

MIT