IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« stdout udp »
Elastic Docs ›Logstash Reference [2.4] ›Output plugins

tcp

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

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

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.

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.

« stdout udp »