docker-stream-cleanser

Docker Stream Cleanser

Docker Stream Cleanser is a drop-in module to clean the headers from Docker Logs

• Cleans the header from finished, stored logs
• Cleans as it pipes from one stream to another
• Accounts for any irregularities in streaming
• Handles any encoding (Ones compatible with Node.js Buffer)

Seeing weird characters at the beginning of each line coming from your Docker container's log stream? This will clear that right up! Docker places a header on each message to help you determine which stream (stdout or stderr) a message should belong to. Thanks Docker, but I just want to read the output! Since there is no setting to turn off this functionality, I wrote this.

More info on Docker's Container Logs

Usage

For clearing from stored logs:

var streamCleanser = require('docker-stream-cleanser');

function(theData) {
    var cleansed = streamCleanser(theData, 'hex');
}

OR

var streamCleanser = require('docker-stream-cleanser');

function(theStream) {
    var cleansed = streamCleanser.async(theStream, 'hex', function(data) {
      console.log('the data!', data);
    });
}

For clearing between streams:

var streamCleanser = require('docker-stream-cleanser');
function(theStream) {
    var cleansed = streamCleanser.cleanStreams(theStream, process.stdout, 'hex', true);
}



// cleanStreams(inputStream, outputStream, encoding, addCarraigeReturn)
// addCarraigeReturn is a flag to replace all \n's in the stream with \r\n

For more info, look at the header comments and the tests

Installation

npm install docker-stream-cleanser --save

License

MIT