beatsedit

This input plugin enables Logstash to receive events from the Elastic Beats framework.

The following example shows how to configure Logstash to listen on port 5044 for incoming Beats connections and to index into Elasticsearch:

input {
  beats {
    port => 5044
  }
}

output {
  elasticsearch {
    hosts => "localhost:9200"
    manage_template => false
    index => "%{[@metadata][beat]}-%{+YYYY.MM.dd}"
    document_type => "%{[@metadata][type]}"
  }
}
Note

The Beats shipper automatically sets the type field on the event. You cannot override this setting in the Logstash config. If you specify a setting for the type config option in Logstash, it is ignored.

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

beats {
    port => ...
}

Available configuration options:

Setting Input typeRequiredDefault value

add_field

hash

No

{}

codec

codec

No

"plain"

congestion_threshold

number

No

5

host

string

No

"0.0.0.0"

port

number

Yes

ssl

boolean

No

false

ssl_certificate

a valid filesystem path

No

ssl_certificate_authorities

array

No

[]

ssl_key

a valid filesystem path

No

ssl_key_passphrase

password

No

ssl_verify_mode

string, one of ["none", "peer", "force_peer"]

No

"none"

tags

array

No

target_field_for_codec

string

No

"message"

type

string

No

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

codecedit

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

congestion_thresholdedit

  • Value type is number
  • Default value is 5

The number of seconds before we raise a timeout. This option is useful to control how much time to wait if something is blocking the pipeline.

hostedit

  • Value type is string
  • Default value is "0.0.0.0"

The IP address to listen on.

portedit

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

The port to listen on.

ssledit

  • Value type is boolean
  • Default value is false

Events are by default sent in plain text. You can enable encryption by setting ssl to true and configuring the ssl_certificate and ssl_key options.

ssl_certificateedit

  • Value type is path
  • There is no default value for this setting.

SSL certificate to use.

ssl_certificate_authoritiesedit

  • Value type is array
  • Default value is []

Validate client certificates against these authorities You can define multiple files or path. All the certificates will be read and added to the trust store. You need to configure the ssl_verify_mode to peer or force_peer to enable the verification.

This feature only supports certificates that are directly signed by your root CA. Intermediate CA are currently not supported.

ssl_keyedit

  • Value type is path
  • There is no default value for this setting.

SSL key to use.

ssl_key_passphraseedit

  • Value type is password
  • There is no default value for this setting.

SSL key passphrase to use.

ssl_verify_modeedit

  • Value can be any of: none, peer, force_peer
  • Default value is "none"

By default the server doesn’t do any client verification,

peer will make the server ask the client to provide a certificate, if the client provides a certificate it will be validated.

force_peer will make the server ask the client to provide a certificate. If the client doesn’t provide a certificate, the connection will be closed.

This option needs to be used with ssl_certificate_authorities and a defined list of CA.

tagsedit

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

target_field_for_codecedit

  • Value type is string
  • Default value is "message"

This is the default field to which the specified codec will be applied.

typeedit

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