Sqlite input plugin
editSqlite input plugin
edit- Plugin version: v3.0.4
- Released on: 2018-04-06
- Changelog
For other versions, see the Versioned plugin docs.
Installation
editFor plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-input-sqlite
. See Working with plugins for more details.
Getting help
editFor 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
editRead 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" }
Sqlite Input Configuration Options
editThis plugin supports the following configuration options plus the Common options described later.
Also see Common options for a list of options supported by all input plugins.
batch
edit- Value type is number
-
Default value is
5
How many rows to fetch at a time from each SELECT
call.
Common options
editThese configuration options are supported by all input plugins:
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
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 sqlite inputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
input { sqlite { id => "my_plugin_id" } }
Variable substitution in the id
field only supports environment variables
and does not support the use of values from the secret store.
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.