Tcp output pluginedit

  • Plugin version: v4.0.2
  • Released on: 2017-08-18
  • Changelog

Installationedit

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

Getting Helpedit

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.

Descriptionedit

Write events over a TCP socket.

Each event json is separated by a newline.

Can either accept connections from clients or connect to a server, depending on mode.

Tcp Output Configuration Optionsedit

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

Setting Input typeRequired

host

string

Yes

mode

string, one of ["server", "client"]

No

port

number

Yes

reconnect_interval

number

No

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 output plugins.

 

hostedit

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

When mode is server, the address to listen on. When mode is client, the address to connect to.

message_format (DEPRECATED)edit

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is string
  • There is no default value for this setting.

The format to use when writing events to the file. This value supports any string and can include %{name} and other dynamic strings.

If this setting is omitted, the full json representation of the event will be written as a single line.

modeedit

  • Value can be any of: server, client
  • Default value is "client"

Mode to operate in. server listens for client connections, client connects to a server.

portedit

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

When mode is server, the port to listen on. When mode is client, the port to connect to.

reconnect_intervaledit

  • Value type is number
  • Default value is 10

When connect failed,retry interval in sec.

ssl_cacertedit

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

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

SSL certificate path

ssl_enableedit

  • Value type is boolean
  • Default value is false

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

ssl_keyedit

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

SSL key path

ssl_key_passphraseedit

  • Value type is password
  • Default value is nil

SSL key passphrase

ssl_verifyedit

  • Value type is boolean
  • Default value is false

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.

Common Optionsedit

The following configuration options are supported by all output plugins:

Setting Input typeRequired

codec

codec

No

enable_metric

boolean

No

id

string

No

workers

number

No

codecedit

  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

enable_metricedit

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

output {
  tcp {
    id => "my_plugin_id"
  }
}

workersedit

  • Value type is string
  • Default value is 1