socket_server

Creates a server that receives a stream of messages over a tcp, udp or unix socket.

Common

# Common config fields, showing default values
input:
  label: ""
  socket_server:
    network: ""
    address: ""
    codec: lines
    tls:
      cert_file: ""
      key_file: ""
      self_signed: false

Advanced

# All config fields, showing default values
input:
  label: ""
  socket_server:
    network: ""
    address: ""
    codec: lines
    max_buffer: 1000000
    tls:
      cert_file: ""
      key_file: ""
      self_signed: false

The field max_buffer specifies the maximum amount of memory to allocate per connection for buffering lines of data. If a line of data from a connection exceeds this value then the connection will be closed.

Fields

network

A network type to accept.

Type: string
Default: ""
Options: unix, tcp, udp, tls.

address

The address to listen from.

Type: string
Default: ""

# Examples

address: /tmp/benthos.sock

address: 0.0.0.0:6000

codec

The way in which the bytes of a data source should be converted into discrete messages, codecs are useful for specifying how large files or continuous streams of data might be processed in small chunks rather than loading it all in memory. It's possible to consume lines using a custom delimiter with the delim:x codec, where x is the character sequence custom delimiter. Codecs can be chained with /, for example a gzip compressed CSV file can be consumed with the codec gzip/csv.

Type: string
Default: "lines"
Requires version 3.42.0 or newer

Option	Summary
auto	EXPERIMENTAL: Attempts to derive a codec for each file based on information such as the extension. For example, a .tar.gz file would be consumed with the gzip/tar codec. Defaults to all-bytes.
all-bytes	Consume the entire file as a single binary message.
avro-ocf:marshaler=x	EXPERIMENTAL: Consume a stream of Avro OCF datum. The marshaler parameter is optional and has the options: goavro (default), json. Use goavro if OCF contains logical types.
chunker:x	Consume the file in chunks of a given number of bytes.
csv	Consume structured rows as comma separated values, the first row must be a header row.
csv:x	Consume structured rows as values separated by a custom delimiter, the first row must be a header row. The custom delimiter must be a single character, e.g. the codec "csv:\t" would consume a tab delimited file.
csv-safe	Consume structured rows like csv, but sends messages with empty maps on failure to parse. Includes row number and parsing errors (if any) in the message's metadata.
csv-safe:x	Consume structured rows like csv:x as values separated by a custom delimiter, but sends messages with empty maps on failure to parse. The custom delimiter must be a single character, e.g. the codec "csv-safe:\t" would consume a tab delimited file. Includes row number and parsing errors (if any) in the message's metadata.
delim:x	Consume the file in segments divided by a custom delimiter.
gzip	Decompress a gzip file, this codec should precede another codec, e.g. gzip/all-bytes, gzip/tar, gzip/csv, etc.
pgzip	Decompress a gzip file in parallel, this codec should precede another codec, e.g. pgzip/all-bytes, pgzip/tar, pgzip/csv, etc.
lines	Consume the file in segments divided by linebreaks.
multipart	Consumes the output of another codec and batches messages together. A batch ends when an empty message is consumed. For example, the codec lines/multipart could be used to consume multipart messages where an empty line indicates the end of each batch.
regex:(?m)^\d\d:\d\d:\d\d	Consume the file in segments divided by regular expression.
skipbom	Skip one or more byte order marks for each opened reader, this codec should precede another codec, e.g. skipbom/csv, etc.
tar	Parse the file as a tar archive, and consume each file of the archive as a message.

# Examples

codec: lines

codec: "delim:\t"

codec: delim:foobar

codec: gzip/csv

max_buffer

The maximum message buffer size. Must exceed the largest message to be consumed.

Type: int
Default: 1000000

tls

TLS specific configuration, valid when the network is set to tls.

Type: object

tls.cert_file

PEM encoded certificate for use with TLS.

Type: string
Default: ""

tls.key_file

PEM encoded private key for use with TLS.

Type: string
Default: ""

tls.self_signed

Whether to generate self signed certificates.

Type: bool
Default: false