« Journald input plugin v2.0.2 Versioned kafka input plugin docs »

› › ›

Journald input plugin v2.0.1

edit

Journald input plugin v2.0.1

edit

Plugin version: v2.0.1
Released on: 2017-06-23
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

Pull events from a local systemd journal.

See requirements https://github.com/ledbettj/systemd-journal

Journald Input Configuration Options

edit

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

Setting	Input type	Required
`filter`	hash	No
`flags`	string, one of `[0, 1, 2, 4]`	No
`lowercase`	boolean	No
`path`	string	No
`seekto`	string, one of `["head", "tail"]`	No
`sincedb_path`	string	No
`sincedb_write_interval`	number	No
`thisboot`	boolean	No
`threads`	number	No
`wait_timeout`	number	No

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

`filter`

edit

Value type is hash
Default value is {}

Filter on events. Not heavily tested.

`flags`

edit

Value can be any of: 0, 1, 2, 4
Default value is 0

System journal flags 0 = all avalable 1 = local only 2 = runtime only 4 = system only

`lowercase`

edit

Value type is boolean
Default value is false

Lowercase annoying UPPERCASE fieldnames. (May clobber existing fields)

`path`

edit

Value type is string
Default value is "/var/log/journal"

Path to read journal files from

`seekto`

edit

Value can be any of: head, tail
Default value is "tail"

Where in the journal to start capturing logs Options: head, tail

`sincedb_path`

edit

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

Where to write the sincedb database (keeps track of the current position of the journal). The default will write the sincedb file to matching $HOME/.sincedb_journal

`sincedb_write_interval`

edit

Value type is number
Default value is 15

How often (in seconds) to write a since database with the current position of the journal.

`thisboot`

edit

Value type is boolean
Default value is true

Filter logs since the system booted (only relevant with seekto ⇒ "head")

`threads`

edit

Value type is number
Default value is 1

`wait_timeout`

edit

Value type is number
Default value is 3000000

The max timeout in microsends to wait for new events from the journal. Set to -1 to wait indefinitely. Setting this to a large value will result in delayed shutdown of the plugin.

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

input {
  journald {
    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.

« Journald input plugin v2.0.2 Versioned kafka input plugin docs »