Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme.md file #11

Merged
merged 1 commit into from Feb 7, 2017
Merged
Changes from all commits
Commits
File filter...
Filter file types
Jump to…
Jump to file
Failed to load files.

Always

Just for now

update readme.md file

Added information about buffer support and making buffer size and retriesInMilliSeconds configurable in library.
  • Loading branch information
Shwetajain148 committed Feb 6, 2017
commit 77b183f70cfdf90b10d733842506a9d1e79e1512
@@ -23,6 +23,20 @@ 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.
@@ -34,7 +48,9 @@ The Loggly transport is based on [Nodejitsu's][2] [node-loggly][3] implementatio
* __tags:__ An array of tags to send to loggly.
* __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.

*Metadata:* Logged in suggested [Loggly format][5]

@@ -92,4 +108,4 @@ Once you have valid configuration and credentials you can run tests with [npm][7
[4]: http://www.loggly.com/product/
[5]: http://www.loggly.com/docs/automated-parsing/
[6]: http://vowsjs.org
[7]: http://npmjs.org
[7]: http://npmjs.org
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.