Configure the Logstash output

The Logstash output sends events directly to Logstash by using the lumberjack protocol, which runs over TCP. Logstash allows for additional processing and routing of generated events.

If you want to use Logstash to perform additional processing on the data collected by Winlogbeat, you need to configure Winlogbeat to use Logstash.

To do this, edit the Winlogbeat configuration file to disable the Elasticsearch output by commenting it out and enable the Logstash output by uncommenting the Logstash section:

output.logstash:
  hosts: ["127.0.0.1:5044"]

The hosts option specifies the Logstash server and the port (5044) where Logstash is configured to listen for incoming Beats connections.

For this configuration, you must load the index template into Elasticsearch manually because the options for auto loading the template are only available for the Elasticsearch output.

Every event sent to Logstash contains the following metadata fields that you can use in Logstash for indexing and filtering:

{
    ...
    "@metadata": { 1
      "beat": "winlogbeat", 2
      "version": "9.0.0-beta1" 3
    }
}

1. Winlogbeat uses the @metadata field to send metadata to Logstash. See the Logstash documentation for more about the @metadata field.
2. The default is winlogbeat. To change this value, set the index option in the Winlogbeat config file.
3. The current version of Winlogbeat.

You can access this metadata from within the Logstash config file to set values dynamically based on the contents of the metadata.

For example, the following Logstash configuration file tells Logstash to use the index reported by Winlogbeat for indexing events into Elasticsearch:

input {
  beats {
    port => 5044
  }
}

output {
  elasticsearch {
    hosts => ["http://localhost:9200"]
    index => "%{[@metadata][beat]}-%{[@metadata][version]}" 1
    action => "create"
  }
}

1. %{[@metadata][beat]} sets the first part of the index name to the value of the beat metadata field and %{[@metadata][version]} sets the second part to the Beat’s version. For example: winlogbeat-9.0.0-beta1.

Events indexed into Elasticsearch with the Logstash configuration shown here will be similar to events directly indexed by Winlogbeat into Elasticsearch.

This output works with all compatible versions of Logstash. See the Elastic Support Matrix.

You can specify the following options in the logstash section of the winlogbeat.yml config file:

The enabled config is a boolean setting to enable or disable the output. If set to false, the output is disabled.

The default value is true.

The list of known Logstash servers to connect to. If load balancing is disabled, but multiple hosts are configured, one host is selected randomly (there is no precedence). If one host becomes unreachable, another one is selected randomly.

All entries in this list can contain a port number. The default port number 5044 will be used if no number is given.

The gzip compression level. Setting this value to 0 disables compression. The compression level must be in the range of 1 (best speed) to 9 (best compression).

Increasing the compression level will reduce the network usage but will increase the CPU usage.

The default value is 3.

Configure escaping of HTML in strings. Set to true to enable escaping.

The default value is false.

The number of workers per configured host publishing events to Logstash. This is best used with load balancing mode enabled. Example: If you have 2 hosts and 3 workers, in total 6 workers are started (3 for each host).

When loadbalance: true is set, Winlogbeat connects to all configured hosts and sends data through all connections in parallel. If a connection fails, data is sent to the remaining hosts until it can be reestablished. Data will still be sent as long as Winlogbeat can connect to at least one of its configured hosts.

When loadbalance: false is set, Winlogbeat sends data to a single host at a time. The target host is chosen at random from the list of configured hosts, and all data is sent to that target until the connection fails, when a new target is selected. Data will still be sent as long as Winlogbeat can connect to at least one of its configured hosts. To rotate through the list of configured hosts over time, use this option in conjunction with the ttl setting to close the connection at the configured interval and choose a new target host.

The default value is false.

output.logstash:
  hosts: ["localhost:5044", "localhost:5045"]
  loadbalance: true
  index: winlogbeat

Time to live for a connection to Logstash after which the connection will be re-established. Useful when Logstash hosts represent load balancers. Since the connections to Logstash hosts are sticky, operating behind load balancers can lead to uneven load distribution between the instances. Specifying a TTL on the connection allows to achieve equal connection distribution between the instances. Specifying a TTL of 0 will disable this feature.

The default value is 0. This setting accepts duration data type values.

Configures the number of batches to be sent asynchronously to Logstash while waiting for ACK from Logstash. Output only becomes blocking once number of pipelining batches have been written. Pipelining is disabled if a value of 0 is configured. The default value is 2.

The URL of the SOCKS5 proxy to use when connecting to the Logstash servers. The value must be a URL with a scheme of socks5://. The protocol used to communicate to Logstash is not based on HTTP so a web-proxy cannot be used.

If the SOCKS5 proxy server requires client authentication, then a username and password can be embedded in the URL as shown in the example.

When using a proxy, hostnames are resolved on the proxy server instead of on the client. You can change this behavior by setting the proxy_use_local_resolver option.

output.logstash:
  hosts: ["remote-host:5044"]
  proxy_url: socks5://user:password@socks5-proxy:2233

The proxy_use_local_resolver option determines if Logstash hostnames are resolved locally when using a proxy. The default value is false, which means that when a proxy is used the name resolution occurs on the proxy server.

The index root name to write events to. The default is the Beat name. For example "winlogbeat" generates "[winlogbeat-]9.0.0-beta1-YYYY.MM.DD" indices (for example, "winlogbeat-9.0.0-beta1-2017.04.26").

Configuration options for SSL parameters like the root CA for Logstash connections. See SSL for more information. To use SSL, you must also configure the Beats input plugin for Logstash to use SSL/TLS.

The number of seconds to wait for responses from the Logstash server before timing out. The default is 30 (seconds).

Winlogbeat ignores the max_retries setting and retries indefinitely.

The maximum number of events to bulk in a single Logstash request. The default is 2048.

Events can be collected into batches. Winlogbeat will split batches read from the queue which are larger than bulk_max_size into multiple batches.

Specifying a larger batch size can improve performance by lowering the overhead of sending events. However big batch sizes can also increase processing times, which might result in API errors, killed connections, timed-out publishing requests, and, ultimately, lower throughput.

Setting bulk_max_size to values less than or equal to 0 disables the splitting of batches. When splitting is disabled, the queue decides on the number of events to be contained in a batch.

If enabled, only a subset of events in a batch of events is transferred per transaction. The number of events to be sent increases up to bulk_max_size if no error is encountered. On error, the number of events per transaction is reduced again.

The default is false.

The number of seconds to wait before trying to reconnect to Logstash after a network error. After waiting backoff.init seconds, Winlogbeat tries to reconnect. If the attempt fails, the backoff timer is increased exponentially up to backoff.max. After a successful connection, the backoff timer is reset. The default is 1s.

The maximum number of seconds to wait before attempting to connect to Logstash after a network error. The default is 60s.

Configuration options for internal queue.

See Internal queue for more information.

Note:queue options can be set under winlogbeat.yml or the output section but not both.