README.md

bunyan-tcp

TCP transport for Bunyan with reconnection.

Quick start:

var tcpStream = bunyanTcp.createBunyanStream({
  server: 'my.logging.server',
  port: 1234,
});

var log = bunyan.createLogger({
    name: 'log',
    streams: [
        {
          level: 'info',
          stream: tcpStream,
          type: 'raw',
          closeOnExit: true
        }
    ]
});

Options

Name	Description	Default
server (required)	The host to connect to	none
port (required)	The server port to connect to	none
reconnectDelay	Time to pause between disconnect and reconnect (in ms)	5000ms
offlineBuffer	Number of messages to buffer while disconnected	100 messages
transform	A function that takes a bunyan event and returns a JSON object that will be serialized to the remote server	identity

Events

Name	Description	Arguments
connecting	Emitted when the stream attempts a connection	Number of unsuccessful connection attempts
connect	Emitted on successful connection	Number of successful connections during the life of this process.
disconnect	Got disconnected from the remote server	none
dropped_messages	Emitted when the stream reconnects if some events have been discarded to stay in buffer limits	Number of dropped messages.

Methods

Name	Description
connect	If previously closed, attempts to reconnect. This is called on instantiation.
close	Disconnect from the remote server
bufferedMessageCount	If currently disconnected, the number of messages in offline buffer
droppedMessageCount	If currently disconnected, number of messages that have been discarded