Tcp output plugin

• Plugin version: v7.0.0
• Released on: 2025-01-10
• Changelog

For other versions, see the Versioned plugin docs.

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.

Write events over a TCP socket.

By default this plugin uses the json codec. In order to have each event json separated by a newline, use the json_lines codec.

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.

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.

Path to certificate in PEM format. This certificate will be presented to the other part of the TLS connection.

• Value type is array
• Default value is []

Validate client certificate or certificate chain against these authorities. You can define multiple files. All the certificates will be read and added to the trust store. The system CA path is automatically included.

• Value type is a list of string
• There is no default value for this setting

The list of cipher suites to use, listed by priorities. Supported cipher suites vary depending on the Java and protocol versions.

• Value can be any of: none, optional, required
• Default value is none

Controls the server’s behavior in regard to requesting a certificate from client connections: none disables the client authentication. required forces a client to present a certificate, while optional requests a client certificate but the client is not required to present one.

When mutual TLS is enabled (optional or required), the certificate presented by the client must be signed by trusted ssl_certificate_authorities (CAs). Please note that the server does not validate the client certificate CN (Common Name) or SAN (Subject Alternative Name).

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

• Value can be any of: full, none
• Default value is full

Defines how to verify the certificates presented by another part in the TLS connection:

full validates that the server certificate has an issue date that’s within the not_before and not_after dates; chains to a trusted Certificate Authority (CA), and has a hostname or IP address that matches the names within the certificate.

none performs no certificate validation.

These configuration options are supported by all output plugins:

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