---
title: Socket
slug: telemetry-pipeline/I1oD-socket
docTags: 
createdAt: 2025-04-20T16:27:47.498Z
---



### Connection Settings

### Address (required, string):

- The socket or systemd socket to bind to. If using a socket, include a port number.

### Connection\_limit (optional, uint):

Maximum allowed TCP connections at once.

Applies when mode = "tcp".

### Mode (required, string enum):

Defines the socket type:

tcp, udp, unix\_datagram, or unix\_stream.

### Path (required when using Unix sockets):

Absolute path to the Unix domain socket file.

### Permit\_origin (optional, \[string]):

List of allowed IP CIDR ranges.

TCP mode only.

### Host\_key / port\_key (optional, string):

Overrides for the log field names capturing host and port.

receive\_buffer\_bytes (optional, uint):

Receive buffer size per connection.



### Max\_connection\_duration\_secs (optional, uint):

Closes connections after this duration to support load balancing.

TCP mode only.



### Max\_length (optional, uint):

Limits the size of UDP messages.

UDP mode only. Default: 102400 bytes.



### Shutdown\_timeout\_secs (optional, uint):

Time to wait before forcibly closing connections during shutdown.

Default: 30 seconds.



### socket\_file\_mode (optional, uint):

File permission bits for Unix socket files.



### keepalive.time\_secs (optional, uint):

Delay before sending TCP keepalive probes.

TCP mode only.



### 🔍 Decoding Settings

- decoding.codec (optional, enum):

Format used to decode raw bytes.

- Supported values: avro, bytes, gelf, influxdb, json, native, native\_json, protobuf, syslog, vrl.

Default: bytes.

Each codec may have its own nested configuration:

### 📦 Avro

- schema (required, string): Avro schema definition.
- strip\_schema\_id\_prefix (required, bool): Strip Confluent-style schema ID prefixes.

### ⚙️ GELF / InfluxDB / JSON / Native JSON / Syslog

- lossy (optional, bool): Replace invalid UTF-8 with U+FFFD.

Default: true.

### 🧬 Protobuf

- desc\_file (optional, string): Path to descriptor file.
- message\_type (optional, string): Message type to decode.

### 🧾 VRL

- source (required, string): VRL program.
- timezone (optional, string): Time zone for timestamp parsing. Default: local.

# 🧱 Framing Settings

- framing.method (required, enum):

Determines how byte streams are split into events:

bytes, character\_delimited, chunked\_gelf, length\_delimited, newline\_delimited, octet\_counting.

Each method may have its own config:

### 🔤 Character Delimited

- delimiter (required, ascii\_char): Delimiter character.
- max\_length (optional, uint): Max buffer size (excluding delimiter).

### 🧩 Chunked GELF

- decompression (optional, enum): Auto, Gzip, Zlib, None.
- max\_length (optional, uint): Max full message size.
- pending\_messages\_limit (optional, uint): Limit on incomplete GELF messages.
- timeout\_secs (optional, float): Time to receive full message. Default: 5.



### 📏 Length Delimited

- length\_field\_is\_big\_endian (optional, bool): Byte order. Default: true.
- length\_field\_length (optional, uint): Byte size of the length field.
- length\_field\_offset (optional, uint): Bytes before the length field.
- max\_frame\_length (optional, uint): Max frame size. Default: 8,388,608 bytes.



### 🆕 Newline Delimited

- max\_length (optional, uint): Max buffer size.



### 🔢 Octet Counting

- max\_length (optional, uint): Max buffer size.



# 🔐 TLS Settings

- tls.enabled (optional, bool): Enable TLS for connections.
- tls.ca\_file / crt\_file / key\_file (optional, string):
- Paths to CA, certificate, and private key files (PEM, DER, or PKCS#12 formats).
- key\_pass (optional, string): Passphrase for encrypted keys.
- alpn\_protocols (optional, \[string]): ALPN protocols in priority order.
- client\_metadata\_key (optional, string): Field for client cert metadata.
- server\_name (optional, string): SNI server name for outgoing TLS.
- verify\_certificate / verify\_hostname (optional, bool):

Enforce validation of peer certificates and hostnames.

Do not disable unless necessary.





![](https://api.archbee.com/api/optimize/g9cApVza9NIhSh0pjZYtA/3S0_-WkdKcWI9OVWK61kg_image.png)