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 for flushLogsAndExit function #24

Merged
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 README.md file for flushLogsAndExit function

  • Loading branch information
Shwetajain148
Shwetajain148 committed Aug 9, 2017
commit b08406da2104e2fe7de0c11c33baece350713299
@@ -54,6 +54,23 @@ bufferOptions: {
```
* __Note:__ The default value of buffer size and retries in milliseconds are 500 and 30000 (30 seconds) respectively.

## Flush logs and exit

Our library uses ajax requests to send logs to Loggly and ajax requests take time to complete, in that case if you call process.exit() externally in your application then it is certain that as soon as process.exit() will be called, your application will exit and all the queued requests will be interrupted and your application logs will also not reach to Loggly.

To support this scenario in which you really want to call process.exit() without losting logs, we have a function called flushLogsAndExit() which waits for 10 seconds and then call process.exit() itself. By doing so, logging will be complete in given time and then your apllication will exit.

You have to do something like below code snippet:

``` js
var winston = require('winston'),
winlog = require('winston-loggly-bulk');
winston.log("info", "hello World");
winlog.flushLogsAndExit();
```

## 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.