IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« metriccatcher nagios »

› ›

mongodb

edit

mongodb

edit

This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-mongodb.

Writes events to MongoDB.

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

mongodb {
    collection => ...
    database => ...
    uri => ...
}

Available configuration options:

Setting	Input type	Required	Default value
`codec`	codec	No	`"plain"`
`collection`	string	Yes
`database`	string	Yes
`generateId`	boolean	No	`false`
`isodate`	boolean	No	`false`
`retry_delay`	number	No	`3`
`uri`	string	Yes
`workers`	number	No	`1`

Details

edit

`codec`

edit

Value type is codec
Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

`collection`

edit

This is a required setting.
Value type is string
There is no default value for this setting.

The collection to use. This value can use %{foo} values to dynamically select a collection based on data in the event.

`database`

edit

This is a required setting.
Value type is string
There is no default value for this setting.

The database to use

`generateId`

edit

Value type is boolean
Default value is false

If true, an "_id" field will be added to the document before insertion. The "_id" field will use the timestamp of the event and overwrite an existing "_id" field in the event.

`isodate`

edit

Value type is boolean
Default value is false

If true, store the @timestamp field in mongodb as an ISODate type instead of an ISO8601 string. For more information about this, see http://www.mongodb.org/display/DOCS/Dates

`retry_delay`

edit

Value type is number
Default value is 3

Number of seconds to wait after failure before retrying

`uri`

edit

This is a required setting.
Value type is string
There is no default value for this setting.

a MongoDB URI to connect to See http://docs.mongodb.org/manual/reference/connection-string/

`workers`

edit

Value type is number
Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.

« metriccatcher nagios »