New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« syslog udp »
Elastic Docs ›Logstash Reference [5.0] ›Output plugins

tcp

edit

tcp

edit

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.

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

tcp {
    host => ...
    port => ...
}

Available configuration options:

Setting Input type Required Default value

codec

codec

No

"json"

host

string

Yes

mode

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

No

"client"

port

number

Yes

reconnect_interval

number

No

10

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

false

workers

number

No

1

Details

edit

 

codec

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

host

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

mode

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

port

edit
  • 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_interval

edit
  • Value type is number
  • Default value is 10

When connect failed,retry interval in sec.

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

workers

edit
  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.

« syslog udp »