diff --git a/README.md b/README.md index d53aad787..054a8bb21 100644 --- a/README.md +++ b/README.md @@ -658,13 +658,18 @@ As of `0.3.0` the MongoDB transport has been broken out into a new module: [wins The MongoDB transport takes the following options. 'db' is required: -* __level:__ Level of messages that this transport should log. -* __silent:__ Boolean flag indicating whether to suppress output. +* __level:__ Level of messages that this transport should log, defaults to 'info'. +* __silent:__ Boolean flag indicating whether to suppress output, defaults to false. + * __db:__ The name of the database you want to log to. *[required]* * __collection__: The name of the collection you want to store log messages in, defaults to 'log'. * __safe:__ Boolean indicating if you want eventual consistency on your log messages, if set to true it requires an extra round trip to the server to ensure the write was committed, defaults to true. * __host:__ The host running MongoDB, defaults to localhost. * __port:__ The port on the host that MongoDB is running on, defaults to MongoDB's default port. +* __username:__ The username to use when logging into MongoDB. +* __password:__ The password to use when logging into MongoDB. If you don't supply a username and password it will not use MongoDB authentication. +* __errorTimeout:__ Reconnect timeout upon connection error from Mongo, defaults to 10 seconds (10000). +* __timeout:__ Timeout for keeping idle connection to Mongo alive, defaults to 10 seconds (10000). *Metadata:* Logged as a native JSON object. @@ -851,4 +856,4 @@ All of the winston tests are written in [vows][9], and designed to be run with n [7]: https://github.com/feisty/BigBrother [8]: http://loggly.com [9]: http://vowsjs.org -[10]: http://nodejs.org/api/util.html#util_util_format_format \ No newline at end of file +[10]: http://nodejs.org/api/util.html#util_util_format_format