tcp

Status: beta

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 {
    host => ... # string (required)
    mode => ... # ["server", "client"] (optional), default: "client"
    port => ... # number (required)
    tags => ... # array (optional), default: []
    type => ... # string (optional), default: ""
  }
}

Details

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.

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.

tags

• 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

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

---

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