From 3a23011b53e37d653cfc8f24478cc97e1ac55683 Mon Sep 17 00:00:00 2001 From: Shwetajain148 Date: Wed, 12 Apr 2017 14:19:41 +0530 Subject: [PATCH 1/2] Update reademe file - add information about timestamp option. - move Buffer Option section after Usage section. --- README.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 8312ea9..91b5384 100644 --- a/README.md +++ b/README.md @@ -22,20 +22,6 @@ A client implementation for Loggly in node.js. Check out Loggly's [Node logging winston.add(winston.transports.Loggly, options); ``` - -## Buffer Support - -This library has buffer support during temporary network outage. User can configure size of buffer (no. of logs to be stored during network outage). - -Add these below configuration in code snippet to override the default values of buffer option __size__ and __retriesInMilliSeconds__. -``` js -bufferOptions: { - size: 1000, - retriesInMilliSeconds: 60 * 1000 -} -``` -* __Note:__ The default value of buffer size and retries in milliseconds are 500 and 30000 (30 seconds) respectively. - The Loggly transport is based on [Nodejitsu's][2] [node-loggly][3] implementation of the [Loggly][0] API. If you haven't heard of Loggly before, you should probably read their [value proposition][4]. The Loggly transport takes the following options. Either 'inputToken' or 'inputName' is required: * __level:__ Level of messages that this transport should log. @@ -48,11 +34,26 @@ The Loggly transport is based on [Nodejitsu's][2] [node-loggly][3] implementatio * __isBulk:__ If true, sends messages using bulk url * __stripColors:__ Strip color codes from the logs before sending * __bufferOptions:__ Buffer options has two configurations. - - __size:__ Number of logs to be buffered. - - __retriesInMilliSeconds:__ Time in milliseconds to retry sending buffered logs. + - __size:__ Number of logs to be buffered. + - __retriesInMilliSeconds:__ Time in milliseconds to retry sending buffered logs. +* __timestamp:__ If false, library will not include timestamp in log events. + - __Note:__ Library includes timestamp by default when we do not set timestamp option. *Metadata:* Logged in suggested [Loggly format][5] +## Buffer Support + +This library has buffer support during temporary network outage. User can configure size of buffer (no. of logs to be stored during network outage). + +Add these below configuration in code snippet to override the default values of buffer option __size__ and __retriesInMilliSeconds__. +``` js +bufferOptions: { + size: 1000, + retriesInMilliSeconds: 60 * 1000 +} +``` +* __Note:__ The default value of buffer size and retries in milliseconds are 500 and 30000 (30 seconds) respectively. + ## Motivation `tldr;?`: To break the [winston][1] codebase into small modules that work together. From 53a48f42a7f2358c33de7b58a1e266f79309d6d8 Mon Sep 17 00:00:00 2001 From: Shwetajain148 Date: Wed, 12 Apr 2017 14:24:16 +0530 Subject: [PATCH 2/2] update package version as per npm package --- package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b4c3d74..af9b4f0 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "winston-loggly-bulk", - "version": "1.3.4", + "version": "1.4.2", "description": "A Loggly transport for winston", "author": "Loggly ", "contributors": [ @@ -30,4 +30,4 @@ "main": "./lib/winston-loggly", "scripts": { "test": "vows --spec" }, "engines": { "node": ">= 0.8.0" } -} \ No newline at end of file +}