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

Version: 3.0.0
Released on: 2017-01-16
Changelog
Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

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

require_relative "bson/logstash_event"

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
`enable_metric`	boolean	No	`true`
`generateId`	boolean	No	`false`
`id`	string	No
`isodate`	boolean	No	`false`
`retry_delay`	number	No	`3`
`uri`	string	Yes
`workers`	<<,>>	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

`enable_metric`

edit

Value type is boolean
Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

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

`id`

edit

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

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

`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 string
Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne

« metriccatcher nagios »