Console broadcasting for Good process monitor

Lead Maintainer: Adam Bretz

good-console is a good reporter implementation to write hapi server events to the console.

Creates a new GoodConsole 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 "*"
• [options] - optional object with the following available keys
  • format - MomentJS format string. Defaults to 'YYMMDD/HHmmss.SSS'.
  • utc - boolean controlling Moment using utc mode or not. Defaults to true.
  • logHeaderPayloadWhenProvided - boolean controlling whether header data is logged as part of GreatResponse events emitted by Good. Good header option must also be enabled to forward header data to Good-Console. Defaults to false.
  • logRequestPayloadWhenProvided - boolean controlling whether request data is logged as part of GreatResponse events emitted by Good. Good requestPayload option must also be enabled to forward request payload data to Good-Console. Defaults to false.

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.

Below are example outputs for the designated event type:

• "ops" - 141225/093015.900, [ops, event.tags], memory: 10Mb, uptime (seconds): 1000, load: [ 1.650390625, 1.6162109375, 1.65234375 ]
• "error" - 141225/093015.900, [error, event.tags], message: there was an error, stack: eventData.stack
• "request" - 141225/093015.900, [request, event.tags], data: {"message":"you made a request to a resource"}
• "log" - 141225/093015.900, [log, event.tags], data: you logged a message
• "response" - 141223/164207.694, [response], localhost: post /data {"name":"adam"} 200 (150ms) response payload: {"foo":"bar","value":1}