relp

edit

This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-input-relp.

Read RELP events over a TCP socket.

For more information about RELP, see http://www.rsyslog.com/doc/imrelp.html

This protocol implements application-level acknowledgements to help protect against message loss.

Message acks only function as far as messages being put into the queue for filters; anything lost after that point will not be retransmitted

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

relp {
    port => ...
}

Available configuration options:

Setting Input type Required Default value

add_field

hash

No

{}

codec

codec

No

"plain"

host

string

No

"0.0.0.0"

port

number

Yes

ssl_cacert

a valid filesystem path

No

ssl_cert

a valid filesystem path

No

ssl_enable

boolean

No

false

ssl_key

a valid filesystem path

No

ssl_key_passphrase

password

No

nil

ssl_verify

boolean

No

true

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.

host

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

The address to listen on.

port

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

The port to listen on.

ssl_cacert

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

The SSL CA certificate, chainfile or CA path. The system CA path is automatically included.

ssl_cert

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

SSL certificate path

ssl_enable

edit
  • Value type is boolean
  • Default value is false

Enable SSL (must be set for other ssl_ options to take effect).

ssl_key

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

SSL key path

ssl_key_passphrase

edit
  • Value type is password
  • Default value is nil

SSL key passphrase

ssl_verify

edit
  • Value type is boolean
  • Default value is true

Verify the identity of the other end of the SSL connection against the CA. For input, sets the field sslsubject to that of the client certificate.

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.