good-mongo
v0.3.0
Published
MongoDB broadcasting for Good process monitor
Downloads
6
Readme
good-mongo
MongoDB broadcasting for Good process monitor
This is a good-reporter implementation to write hapi server events to a MongoDB database.
MongoDB has the concept of a Capped collection and it can be used for logging purposes. This reporter tries to create a capped collection when the plugin is registered. However, it's not required to have the connection open at the time of registering the plugin, it will try to prepare the collection later each time a log event is emitted.
GoodMongo(events, db[, options])
Creates a new GoodMongo instance with the following arguments:
- events - Object
Object with key-value pairs.
key: One of the supported good events indicating the hapi event to subscribe to.
value: A single string or an array of strings to filter incoming events.*
indicates no filtering.null
andundefined
are assumed to be*
. - db - Object
MongoDB'sDb
instance. It's assumed that the connection is already opened, however it won't fail if it's not. The user is responsible for the connection's lifecycle. - options - Object
- capped - Boolean
If the collection doesn't exist, creates a new capped collection. Defaultfalse
. - collection - String
Name of the collection. Default
log
. - force - Boolean
If the collection already exists, it is converted into a capped collection. Defaultfalse
. - max - Number
Maximum number of documents allowed in the capped collection. Defaultundefined
. - onerror - Function
When inserting the event to the database, errors may occur. If the event can't be inserted, then there's surely an issue with MongoDB. This error can be ignored. - size - Number
Size in bytes of the capped collection. Default10000000
(10MB rounded up to the nearest multiple of 256).
- capped - Boolean