:plugin: mongodb
:type: output

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}-{plugin}"]

=== Mongodb output plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

This output writes events to MongoDB.

[id="plugins-{type}s-{plugin}-options"]
==== Mongodb Output Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-bulk>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-bulk_interval>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-bulk_size>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-collection>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-database>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-generateId>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-isodate>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-retry_delay>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-uri>> |<<string,string>>|Yes
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
output plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-bulk"]
===== `bulk` 

  * Value type is <<boolean,boolean>>
  * Default value is `false`

Bulk insert flag, set to true to allow bulk insertion, else it will insert events one by one.

[id="plugins-{type}s-{plugin}-bulk_interval"]
===== `bulk_interval` 

  * Value type is <<number,number>>
  * Default value is `2`

Bulk interval, Used to insert events periodically if the "bulk" flag is activated.

[id="plugins-{type}s-{plugin}-bulk_size"]
===== `bulk_size` 

  * Value type is <<number,number>>
  * Default value is `900`

Bulk events number, if the number of events to insert into a collection raise that limit, it will be bulk inserted
whatever the bulk interval value (mongodb hard limit is 1000).

[id="plugins-{type}s-{plugin}-collection"]
===== `collection` 

  * This is a required setting.
  * Value type is <<string,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.

[id="plugins-{type}s-{plugin}-database"]
===== `database` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

The database to use.

[id="plugins-{type}s-{plugin}-generateId"]
===== `generateId` 

  * Value type is <<boolean,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="plugins-{type}s-{plugin}-isodate"]
===== `isodate` 

  * Value type is <<boolean,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.

[id="plugins-{type}s-{plugin}-retry_delay"]
===== `retry_delay` 

  * Value type is <<number,number>>
  * Default value is `3`

The number of seconds to wait after failure before retrying.

[id="plugins-{type}s-{plugin}-uri"]
===== `uri` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

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



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]