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

« elasticsearch exec »

› ›

eventlog

edit

eventlog

edit

This input will pull events from a Windows Event Log. Note that Windows Event Logs are stored on disk in a binary format and are only accessible from the Win32 API. This means Losgtash needs to be running as an agent on Windows servers where you wish to collect logs from, and will not be accesible across the network.

To collect Events from the System Event Log, use a config like:

    input {
      eventlog {
        type  => 'Win32-EventLog'
        logfile  => 'System'
      }
    }

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

eventlog {
}

Available configuration options:

Setting	Input type	Required	Default value
`add_field`	hash	No	`{}`
`codec`	codec	No	`"plain"`
`logfile`	string	No	`"Application"`
`interval`	number	No	`1000`
`tags`	array	No
`type`	string	No

Details

edit

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

`logfile`

edit

Value type is array
Default value is ["Application", "Security", "System"]

Event Log Name. System and Security may require that privileges are given to the user running Logstash. For more information, see: https://social.technet.microsoft.com/forums/windowsserver/en-US/d2f813db-6142-4b5b-8d86-253ebb740473/easy-way-to-read-security-log

`interval`

edit

Value type is number
Default value is 1000

How frequently should tail check for new event logs in milliseconds

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

« elasticsearch exec »