« Versioned drupal_dblog input plugin docs Drupal_dblog input plugin v2.0.6 »

› › ›

Drupal_dblog input plugin v2.0.7

edit

Drupal_dblog input plugin v2.0.7

edit

Plugin version: v2.0.7
Released on: 2018-04-06
Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting help

edit

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.

Description

edit

Retrieve watchdog log events from a Drupal installation with DBLog enabled. The events are pulled out directly from the database. The original events are not deleted, and on every consecutive run only new events are pulled.

The last watchdog event id that was processed is stored in the Drupal variable table with the name "logstash_last_wid". Delete this variable or set it to 0 if you want to re-import all events.

More info on DBLog: http://drupal.org/documentation/modules/dblog

Drupal_dblog Input Configuration Options

edit

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

Setting	Input type	Required
`add_usernames`	boolean	No
`bulksize`	number	No
`databases`	hash	No
`interval`	number	No

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

`add_usernames`

edit

Value type is boolean
Default value is false

By default, the event only contains the current user id as a field. If you whish to add the username as an additional field, set this to true.

`bulksize`

edit

Value type is number
Default value is 5000

The amount of log messages that should be fetched with each query. Bulk fetching is done to prevent querying huge data sets when lots of messages are in the database.

`databases`

edit

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

Specify all drupal databases that you whish to import from. This can be as many as you whish. The format is a hash, with a unique site name as the key, and a databse url as the value.

Example: [ "site1", "mysql://user1:password@host1.com/databasename", "other_site", "mysql://user2:password@otherhost.com/databasename", … ]

`interval`

edit

Value type is number
Default value is 10

Time between checks in minutes.

Common options

edit

These configuration options are supported by all input plugins:

Setting	Input type	Required
`add_field`	hash	No
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No
`tags`	array	No
`type`	string	No

`add_field`

edit

Value type is hash
Default value is {}

Add a field to an event

`codec`

edit

Value type is codec
Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

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

`id`

edit

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 drupal_dblog inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

input {
  drupal_dblog {
    id => "my_plugin_id"
  }
}

`tags`

edit

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

Add any number of arbitrary tags to your event.

This can help with processing later.

`type`

edit

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

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

« Versioned drupal_dblog input plugin docs Drupal_dblog input plugin v2.0.6 »