> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sawmills.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Syslog Source

> Configure the Syslog source in Sawmills to receive log data via TCP-based syslog using RFC 5424 or RFC 3164 formats with configurable encoding.

## Supported Data Types

📘 **Logs**

## Configuration

| Field    | Type   | Default            | Required | Description                                                                                                                                                            |
| :------- | :----- | :----------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name     | String | none               | true     | Unique identifier within Sawmills.                                                                                                                                     |
| Address  | String | `${env:MY_POD_IP}` | true     | The address (IP or hostname) to receive TCP Logs data.                                                                                                                 |
| Port     | Int    | 514                | true     | The port on which TCP Logs data is received..                                                                                                                          |
| Encoding | String | UTF-8              | true     | The character encoding to use for parsing syslog messages. If no encoding is selected, no encoding validation occurs and the file is treated as a stream of raw bytes. |
| Protocol | String | RFC 5424           | true     | Syslog protocol version that will be used (RFC 5424 or RFC 3164)                                                                                                       |

<Note> The pod’s IP address is retrieved by defining an environment variable `MY_POD_IP` from the pod’s status field `status.podIP`. You can access this value using `${env:MY_POD_IP}` in your configuration to dynamically reference the pod’s IP at runtime. </Note>
<Note> Currently we only support syslog over TCP</Note>