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/package.json #16

Merged
merged 2 commits into from Apr 25, 2017
Merged
Changes from 1 commit
Commits
File filter...
Filter file types
Jump to…
Jump to file
Failed to load files.

Always

Just for now

Next

Update reademe file

- add information about timestamp option.
- move Buffer Option section after Usage section.
  • Loading branch information
Shwetajain148
Shwetajain148 committed Apr 12, 2017
commit 3a23011b53e37d653cfc8f24478cc97e1ac55683
@@ -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.

ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.