• Plugin version: v3.1.8
• Released on: 2025-01-02
• Changelog

For other versions, see theVersioned plugin docs.

For plugins not bundled by default, it is easy to install by runningbin/logstash-plugin install logstash-output-mongodb. SeeWorking with plugins for more details.

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

This output writes events to MongoDB.

This plugin supports the following configuration options plus theCommon options described later.

Also seeCommon options for a list of options supported by all output plugins.

• Value type isboolean
• Default value isfalse

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

• Value type isnumber
• Default value is2

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

• Value type isnumber
• Default value is900

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

• This is a required setting.
• Value type isstring
• 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.

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

The database to use.

• Value type isboolean
• Default value isfalse

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.

• Value type isboolean
• Default value isfalse

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

• Value type isnumber
• Default value is3

The number of seconds to wait after failure before retrying.

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

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

These configuration options are supported by all output plugins:

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

• Value type isboolean
• Default value istrue

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 isstring
• There is no default value for this setting.

Add a uniqueID 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"  }}