Udp broadcasting for Good process monitor

Lead Maintainer: Ulrik Augustsson

good-udp is a good-reporter implementation to write hapi server events to remote endpoints. It sends a request with a JSON payload to the supplied endpoint.

good-udp will never close the udp client.

creates a new GoodUdp 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 - configuration object

  • endpoint - full path to remote server to transmit logs.
  • [threshold] - number of events to hold before transmission. Defaults to 20. Set to 0 to have every event start transmission instantly. It is strongly suggested to have a set threshold to make data transmission more efficient.
  • [udpType] - a string with the type of udp you want to use. Valid options are udp4 or udp6. Defaults to 'udp4'.

  Good Udp Methods

  goodudp.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.

  When stream emits an "end" event, goodudp will transmit any events remaining it it's internal buffer to attempt to prevent data loss.

Each request will match the following schema. Every event will be wrapped inside the events key and grouped by the event type and ordered by the timestamp. The payload that is sent to the endpoint has the following schema:

{
	"host":"servername.home",
	"schema":"good-udp",
	"timeStamp":1412710565121,
	"events":{
		"request":[
			{
				"event":"request",
				"timestamp":1413464014739,
				...
			},
			{
				"event":"request",
				"timestamp":1414221317758,
				...
			},
			{
				"event":"request",
				"timestamp":1415088216608,
				...
			}
		],
		"log":[
			{
				"event":"log",
				"timestamp":1415180913160,
				...
			},
			{
				"event":"log",
				"timestamp":1422493874390,
				...
			}
		]
	}
}