Elastic
Start free trial Contact Sales
Loading

Relp input plugin

  • Plugin version: v3.0.4
  • Released on: 2018-04-06
  • Changelog

For other versions, see the Versioned plugin docs.

Installation

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-input-relp. See Working with plugins for more details.

Getting help

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

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

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

Setting Input type Required
host string No
port number Yes
ssl_cacert a valid filesystem path No
ssl_cert a valid filesystem path No
ssl_enable boolean No
ssl_key a valid filesystem path No
ssl_key_passphrase password No
ssl_verify boolean No

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

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

The address to listen on.

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

The port to listen on.

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

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

SSL certificate path

  • Value type is boolean
  • Default value is false

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

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

SSL key path

  • Value type is password
  • Default value is nil

SSL key passphrase

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

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
  • Value type is hash
  • Default value is {}

Add a field to an event

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

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

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

input {
  relp {
    id => "my_plugin_id"
  }
}
Note

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.

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

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