Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[dist] Version bump. 0.3.4

  • Loading branch information...
commit ce6cb213d778a8a6f7b144e6468a6204d61fa64b 1 parent fceba72
@indexzero indexzero authored
Showing with 18 additions and 17 deletions.
  1. +17 −16 README.md
  2. +1 −1  package.json
View
33 README.md
@@ -2,21 +2,6 @@
A MongoDB transport for [winston][0].
-## Installation
-
-### Installing npm (node package manager)
-
-``` bash
- $ curl http://npmjs.org/install.sh | sh
-```
-
-### Installing winston-mongodb
-
-``` bash
- $ npm install winston
- $ npm install winston-mongodb
-```
-
## Motivation
`tldr;?`: To break the [winston][0] codebase into small modules that work together.
@@ -39,16 +24,32 @@ The MongoDB transport takes the following options. 'db' is required:
* __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.
-* __errortimeout:__ Reconnect timeout upon connection error from Mongo, defaults to 10 seconds (10000).
+* __errorTimeout:__ Reconnect timeout upon connection error from Mongo, defaults to 10 seconds (10000).
* __timeoout:__ Timeout for keeping idle connection to Mongo alive, defaults to 10 seconds (10000).
*Metadata:* Logged as a native JSON object.
+## Installation
+
+### Installing npm (node package manager)
+
+``` bash
+ $ curl http://npmjs.org/install.sh | sh
+```
+
+### Installing winston-mongodb
+
+``` bash
+ $ npm install winston
+ $ npm install winston-mongodb
+```
+
#### Author: [Charlie Robbins](http://blog.nodejitsu.com)
#### Contributors: [Kendrick Taylor](https://github.com/sktaylor), [Yosef Dinerstein](https://github.com/yosefd)
View
2  package.json
@@ -1,7 +1,7 @@
{
"name": "winston-mongodb",
- "description": "A MongoDB transport for winston",
"version": "0.3.4",
+ "description": "A MongoDB transport for winston",
"author": "Charlie Robbins <charlie.robbins@gmail.com>",
"contributors": [
{ "name": "Kendrick Taylor", "email": "sktayloriii@gmail.com", "email": "yosefd@microsoft.com" }
Please sign in to comment.
Something went wrong with that request. Please try again.