Skip to main content

socket

Connects to a (tcp/udp/unix) server and sends a continuous stream of data, dividing messages according to the specified codec.

# Config fields, showing default values
output:
label: ""
socket:
network: "" # No default (required)
address: /tmp/benthos.sock # No default (required)
codec: lines

Fields

network

A network type to connect as.

Type: string
Options: unix, tcp, udp.

address

The address to connect to.

Type: string

# Examples

address: /tmp/benthos.sock

address: 127.0.0.1:6000

codec

The way in which the bytes of messages should be written out into the output data stream. It's possible to write lines using a custom delimiter with the delim:x codec, where x is the character sequence custom delimiter.

Type: string
Default: "lines"

OptionSummary
all-bytesOnly applicable to file based outputs. Writes each message to a file in full, if the file already exists the old content is deleted.
appendAppend each message to the output stream without any delimiter or special encoding.
linesAppend each message to the output stream followed by a line break.
delim:xAppend each message to the output stream followed by a custom delimiter.
# Examples

codec: lines

codec: "delim:\t"

codec: delim:foobar