IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« stdin s3 »

› ›

sqlite

edit

sqlite

edit

This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-input-sqlite.

Read rows from an sqlite database.

This is most useful in cases where you are logging directly to a table. Any tables being watched must have an id column that is monotonically increasing.

All tables are read by default except:

ones matching sqlite_% - these are internal/adminstrative tables for sqlite
since_table - this is used by this plugin to track state.

Example

    % sqlite /tmp/example.db
    sqlite> CREATE TABLE weblogs (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        ip STRING,
        request STRING,
        response INTEGER);
    sqlite> INSERT INTO weblogs (ip, request, response)
        VALUES ("1.2.3.4", "/index.html", 200);

Then with this logstash config:

    input {
      sqlite {
        path => "/tmp/example.db"
        type => weblogs
      }
    }
    output {
      stdout {
        debug => true
      }
    }

Sample output:

    {
      "@source"      => "sqlite://sadness/tmp/x.db",
      "@tags"        => [],
      "@fields"      => {
        "ip"       => "1.2.3.4",
        "request"  => "/index.html",
        "response" => 200
      },
      "@timestamp"   => "2013-05-29T06:16:30.850Z",
      "@source_host" => "sadness",
      "@source_path" => "/tmp/x.db",
      "@message"     => "",
      "@type"        => "foo"
    }

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

sqlite {
    path => ...
}

Available configuration options:

Setting	Input type	Required	Default value
`add_field`	hash	No	`{}`
`batch`	number	No	`5`
`codec`	codec	No	`"plain"`
`exclude_tables`	array	No	`[]`
`path`	string	Yes
`tags`	array	No
`type`	string	No

Details

edit

`add_field`

edit

Value type is hash
Default value is {}

Add a field to an event

`batch`

edit

Value type is number
Default value is 5

How many rows to fetch at a time from each SELECT call.

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

`exclude_tables`

edit

Value type is array
Default value is []

Any tables to exclude by name. By default all tables are followed.

`path`

edit

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

The path to the sqlite database file.

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

« stdin s3 »