mongodb

Milestone: 2

This is a community-contributed plugin! It does not ship with logstash by default, but it is easy to install! To use this, you must have installed the contrib plugins package.

Synopsis

This is what it might look like in your config file:
output {
  mongodb {
    codec => ... # codec (optional), default: "plain"
    collection => ... # string (required)
    database => ... # string (required)
    generateId => ... # boolean (optional), default: false
    isodate => ... # boolean (optional), default: false
    retry_delay => ... # number (optional), default: 3
    uri => ... # string (required)
    workers => ... # number (optional), default: 1
  }
}

Details

codec

  • 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 (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 (required setting)

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

The database to use

exclude_tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

generateId

  • Value type is boolean
  • Default value is false

If true, a _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

  • 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

  • Value type is number
  • Default value is 3

Number of seconds to wait after failure before retrying

tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

uri (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

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


This is documentation from lib/logstash/outputs/mongodb.rb