logstash-docs-md
Loading

Tcp output plugin v6.1.1

  • Plugin version: v6.1.1
  • Released on: 2022-08-21
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

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

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.

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

Setting Input type Required
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_supported_protocols string No
ssl_verify boolean No

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

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

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

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

  • Value type is number
  • Default value is 10

When connect failed,retry interval in sec.

  • 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 string
  • Allowed values are: 'TLSv1.1', 'TLSv1.2', 'TLSv1.3'
  • Default depends on the JDK being used. With up-to-date Logstash, the default is ['TLSv1.2', 'TLSv1.3']. 'TLSv1.1' is not considered secure and is only provided for legacy applications.

List of allowed SSL/TLS versions to use when establishing a secure connection.

Note

If you configure the plugin to use 'TLSv1.1' on any recent JVM, such as the one packaged with Logstash, the protocol is disabled by default and needs to be enabled manually by changing jdk.tls.disabledAlgorithms in the $JDK_HOME/conf/security/java.security configuration file. That is, TLSv1.1 needs to be removed from the list.

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

These configuration options are supported by all output plugins:

Setting Input type Required
codec codec No
enable_metric boolean No
id string No
  • Value type is codec
  • Default value is "json"

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.

  • 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"
  }
}