tcp

Milestone: 2

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

This is what it might look like in your config file: 
output {
  tcp {
    codec => ... # codec (optional), default: "plain"
    host => ... # string (required)
    mode => ... # string, one of ["server", "client"] (optional), default: "client"
    port => ... # number (required)
    reconnect_interval => ... # number (optional), default: 10
    workers => ... # number (optional), default: 1
  }
}

Details

codec

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

exclude_tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

host (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

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • 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

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

  • Value type is number
  • Default value is 10

When connect failed,retry interval in sec.

tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

workers

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

This is documentation from lib/logstash/outputs/tcp.rb