To get Syslog data over TCP, configure XpoLog to listen on a network port for incoming Syslog:
- Go to Manager > Administration > Listeners. The Listeners management console opens.
- Add Syslog TCP account, for each account the following should be configured:
- Name: the name of the Listener account
- Description: the description of the Listener account
- Listening Node: the node in the cluster which will listen to the Syslog messages (appears only if a XpoLog cluster is deployed)
- Port: the port which will be used on the XpoLog machine to receive Syslog messages of this Listener account (usually 1468)
- Advanced Settings:
Enabled: determine whether this account is enabled or not
Listening Interface: the network interface (IP address) on which the XpoLog listener instance is listening
Dynamic Log Creation Configuration:
Parent Folder: the parent folder which all logs from this listener will be place under in XpoLog Folders and Logs tree
Collection Policy: the collection policy which will be associated to all logs from this listener (used mainly for storage location and data retention)
AppTags: the AppTags which will be associated to all the logs from this listener (used mainly for data enrichment)
Log Name Prefix: a prefix which will be added to any of the the logs from this listener (used to easily distinguish between multiple listener accounts logs)
Split by Source Device:
- Do not split - by default, XpoLog will not split the incoming data. All data will be stored under a single log in XpoLog.
- Create log by unique IP / host name - XpoLog will split the incoming data based on the source that sends it to different logs, the log name structure will be "Log_Name_Prefix Source_IP/Name"
- Create log by IP mask - XpoLog will split the incoming data based on matched source to the configured IP mask that sends it to different logs, the log name structure will be "Log_Name_Prefix IP_Mask"
- Create log with Regular expression - XpoLog will split the incoming data to different logs based on a regular expression that will be applied on the Message field. The part in the regular expression that will be used to determine the split should be in (round parentheses).
Records that the regular expression does not return a value will be directed to the global Syslog TCP log.
- Split log by time - XpoLog will split the incoming data based on predefined time intervals, the log name structure will be "Log_Name_Date and Time"
- Log split interval time - The time interval defined for the split: Hour|Day|Month
Select Log Template: The template for a pattern which will be applied to all the logs from this listener (used mainly for data automation and data enrichment)
Listener Data Location: the location which data will be stored to, by default XpoLog stores it in its data directory
Indexing Node: the node in the cluster which will index the received Syslog messages (appears only if a XpoLog cluster is deployed)
Indexing Interval: the frequency in which received Syslog messages are indexed
- Save the account.
- Data received to the Syslog listener account will be created under the configured parent folder and will be available for searching, reporting and alerting.
- For events sent with the TCP protocol, the event size will be based on the maximum length of a TCP packet which is 8192 bytes. Messages that are larger than the maximum size of the RFC specification for the TCP protocol have their event payloads truncated XpoLog can receive the event.
- Multiple listeners accounts may be configured. However, listeners which run on the same machine must listen on a different network port.