to_tcp

Connects to a remote TCP or TLS endpoint and sends events.

to_tcp endpoint:string, [tls=record] { … }

Description

Connects to the specified TCP endpoint as a client and writes serialized events to the connection. Input events are run through a nested pipeline that must produce bytes (e.g., { write_json }).

If the connection fails, the operator reconnects automatically with exponential backoff.

`endpoint: string`

The remote endpoint to connect to. Must be of the form [tcp://]<hostname>:<port>.

`tls = record (optional)`

TLS configuration. Provide an empty record (tls={}) to enable TLS with defaults or set fields to customize it.

{
  skip_peer_verification: bool, // skip certificate verification.
  cacert: string,               // CA bundle to verify peers.
  certfile: string,             // client certificate to present.
  keyfile: string,              // private key for the client certificate.
  min_version: string,          // minimum TLS version (`"1.0"`, `"1.1"`, `"1.2"`, "1.3"`).
  ciphers: string,              // OpenSSL cipher list string.
  client_ca: string,            // CA to validate client certificates.
  require_client_cert,          // require clients to present a certificate.
}

The client_ca and require_client_cert options are only applied for operators that accept incoming client connections, and otherwise ignored.

Any value not specified in the record will either be picked up from the configuration or if not configured will not be used by the operator.

See the Node TLS Setup guide for more details.

`{ … }`

The pipeline to serialize input events into bytes. Must produce bytes as output, for instance { write_json } or { write_csv }.

Examples

Send JSON to a remote server

export
to_tcp "collector.example.com:5044" { write_json }

Send with TLS

export
to_tcp "collector.example.com:5044", tls={} { write_json }

to_tcp

Description

endpoint: string

tls = record (optional)

{ … }