Mongodb output pluginedit

  • Plugin version: v3.1.2
  • Released on: 2017-08-16
  • Changelog

Installationedit

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-mongodb. See Working with plugins for more details.

Getting Helpedit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Descriptionedit

This output writes events to MongoDB.

Mongodb Output Configuration Optionsedit

This plugin supports the following configuration options plus the Common Options described later.

Also see Common Options for a list of options supported by all output plugins.

 

bulkedit

  • Value type is boolean
  • Default value is false

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

bulk_intervaledit

  • Value type is number
  • Default value is 2

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

bulk_sizeedit

  • Value type is 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).

collectionedit

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

databaseedit

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

The database to use.

generateIdedit

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

isodateedit

  • 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_delayedit

  • Value type is number
  • Default value is 3

The number of seconds to wait after failure before retrying.

uriedit

  • 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/.

Common Optionsedit

The following configuration options are supported by all output plugins:

Setting Input typeRequired

codec

codec

No

enable_metric

boolean

No

id

string

No

workers

number

No

codecedit

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

enable_metricedit

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

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

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 mongodb outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  mongodb {
    id => "my_plugin_id"
  }
}

workersedit

  • Value type is string
  • Default value is 1