tcp

Send data to a TCP server

Note that if there is a break in connection, there may be data loss, alhtough we do try to buffer data until reconnection is possible. If a more robust transport is needed, use http (or even rabbitmq).

Field NameDescriptionTypeDefault
addressDestination TCP addressstring-
input-fieldA field from where data is to be read, meaning JSON is assumedfield-
serverOperate as a serverbool-
retryFor operations that could potentially fail--
batch-outSome outputs support batching the output events, by maximum size, timeout, or end of document--

address

Destination TCP address

Type: string

Example

action:

tcp:
  address: 127.0.0.1:8000

input-field

A field from where data is to be read, meaning JSON is assumed

Otherwise the whole event is sent

Type: field

Example

action:

tcp:
  address: 127.0.0.1:8000
  input-field: one

server

Operate as a server

This is where each tcp input connecting to it will receive a copy (fan-out)

Type: bool

retry

For operations that could potentially fail

Field NameDescriptionTypeDefault
countHow many attempts to make before declaring failureinteger-
pauseHow long to pause before re-tryingduration-
foreverkeep trying until success is declaredboolfalse

count

How many attempts to make before declaring failure

Type: integer

Example

action:

exec:
  command: echo 'one two'
  retry:
    count: 1

output:

{"_raw":"one two"}

pause

How long to pause before re-trying

Accepts human-friendly formats, like 1m (for 1 minute) and 4h (for 4 hours)

Type: duration

Example

action:

exec:
  command: echo 'one two'
  retry:
    count: 6
    pause: 10s

output:

{"_raw":"one two"}

forever

keep trying until success is declared

Accepts human-friendly formats, like 1m (for 1 minute) and 4h (for 4 hours)

Type: bool

Example

action:

exec:
  command: echo 'one two'
  retry:
    forever: true

output:

{"_raw":"one two"}

batch-out

Some outputs support batching the output events, by maximum size, timeout, or end of document

v2.8

Field NameDescriptionTypeDefault
batchmaximum number of events in an output batch. If 'document' send on end of document--
timeoutinterval after which the batch is sent, to keep throughput going-100ms
headerput a header line before the batch--
footerput a header line after the last line of the batch--

batch

maximum number of events in an output batch. If 'document' send on end of document

timeout

interval after which the batch is sent, to keep throughput going

put a header line before the batch

put a header line after the last line of the batch