This module accepts TCP connections on the configured address and port. It can handle multiple simultaneous connections. The TCP transfer protocol provides more reliable log transmission than UDP. If security is a concern, consider using the im_ssl module instead.
|To examine the supported platforms, see the list of installer packages in the Available Modules chapter.|
The im_tcp module accepts the following directives in addition to the common module directives.
The module will accept connections on this IP address or DNS hostname. For security, the default listen address is
localhost(the localhost loopback address is not accessible from the outside). To receive logs from remote hosts, the address specified here must be accessible. The any address
0.0.0.0is commonly used here.
The port number can be defined by appending it at the end of the hostname or IP address using a colon as a separator (
host:port). IPv6 addresses must be enclosed in square brackets (
[host]:port). The port section of this directive and the Port directive are mutually exclusive. In case both are defined, the port number defined here takes precedence over a port defined in the Port directive. In case none of them is defined, the default port 514 is used.
To listen on multiple addresses or ports in a single module instance, this directive can be repeated multiple times. Both IPv4 and IPv6 addresses are supported. If a DNS name is used, the number of addresses or cnames should be kept below 16 to avoid potential issues caused by DNS response size limits.
|Formerly called Host, this directive is now ListenAddr. Host for incoming traffic will become deprecated from NXLog EE 6.0.|
For client applications that don’t support IPv6, to avoid the behavior
described above the
Alternatively, the server-side system may be configured to prioritize IPv4
addresses for the hostname specified by the
For more information see the Microsoft documentation on Configuring IPv6 in Windows for advanced users.
This limitation will be addressed in a future release by making listening modules bind to all available IPv4/IPv6 addresses that a hostname resolves to.
The module will listen for incoming connections on this port number. The default port is 514 if this directive is not specified.
|The Port directive will become deprecated from NXLog EE 6.0. After that, the port can only be defined in the ListenAddr directive.|
This optional directive may be used to specify a whitelist of IP addresses and/or networks that are allowed to connect. The directive can be specified more than once to add different IPs or networks to the whitelist. This directive is only active when the Listen or ListenAddr directives are present. In the absence of this directive, there is no restriction on the hosts which may connect to a listening module. The following formats may be used:
0.0.0.0/32(IPv4 network with subnet bits)
0.0.0.0/0.0.0.0(IPv4 network with subnet address)
aa::12/64(IPv6 network with subnet bits)
This optional boolean directive enables synchronous listening on the same port by multiple module instances. Each module instance runs in its own thread, allowing NXLog to process incoming data simultaneously to take better advantage of multiprocessor systems. The default value is FALSE.
To enable synchronous listening, the configuration file should contain multiple im_tcp module instances listening on the same port and the ReusePort directive set to TRUE, see the Examples section.
Pre-v5 syntax examples are included, they will become invalid with NXLog EE 6.0.
With this configuration, NXLog listens for TCP connections on port 1514 and writes the received log messages to a file.
<Input tcp> Module im_tcp ListenAddr 0.0.0.0:1514 </Input> # Using the syntax prior to NXLog EE 5, # where the port is defined in a separate directive. #<Input tcp> # Module im_tcp # Host 0.0.0.0 # Port 1514 #</Input> <Output file> Module om_file File "tmp/output" </Output> <Route tcp_to_file> Path tcp => file </Route>
The configuration below provides two im_tcp module instances to reuse port 1514 via the ReusePort directive.
Received messages are written to the
<Input tcp_one> Module im_tcp ListenAddr 192.168.31.11:1514 ReusePort TRUE </Input> <Input tcp_two> Module im_tcp ListenAddr 192.168.31.11:1514 ReusePort TRUE </Input> # Using the syntax prior to NXLog EE 5, # where the port is defined in a separate directive. #<Input tcp_one> # Module im_tcp # Host 192.168.31.11 # Port 1514 # ReusePort TRUE #/Input> # #<Input tcp_two> # Module im_tcp # Host 192.168.31.11 # Port 1514 # ReusePort TRUE #</Input>