1.1.0 • Published 6 years ago

good-console-logfmt v1.1.0

Weekly downloads
6
License
BSD-3-Clause
Repository
github
Last release
6 years ago

good-console-logfmt

Console broadcasting for Good process monitor, using logfmt formatting

Build StatusCurrent Version

Lead Maintainer: Christopher De Cairos

Usage

good-console-logfmt is a good reporter implementation to write hapi server events to the console. It uses the logfmt package to format log output.

GoodConsoleLogfmt(events, [config])

Creates a new GoodConsoleLogfmt object with the following arguments:

  • events - an object of key value pairs. - key - one of the supported good events indicating the hapi event to subscribe to - value - a single string or an array of strings to filter incoming events. "*" indicates no filtering. null and undefined are assumed to be "*"
  • [config] - optional configuration object with the following available keys - utc - boolean controlling Moment using utc mode or not. Defaults to true.

Good Console Logfmt Methods

goodconsolelogfmt.init(stream, emitter, callback)

Initializes the reporter with the following arguments:

  • stream - a Node readable stream that will be the source of data for this reporter. It is assumed that stream is in objectMode.
  • emitter - an event emitter object.
  • callback - a callback to execute when the start function has complete all the necessary set up steps and is ready to receive data.