- OS Support
- Enterprise Edition Reference Manual
- 136. Man Pages
- 137. Configuration
- 138. Language
- 139. Extension Modules
- 140. Input Modules
- 140.1. Process accounting (im_acct)
- 140.2. AIX auditing (im_aixaudit)
- 140.3. Azure (im_azure)
- 140.4. Batched compression (im_batchcompress)
- 140.5. Basic Security Module Auditing (im_bsm)
- 140.6. Check Point OPSEC LEA (im_checkpoint)
- 140.7. DBI (im_dbi)
- 140.8. Event Tracing for Windows (im_etw)
- 140.9. External programs (im_exec)
- 140.10. File (im_file)
- 140.11. File integrity monitoring (im_fim)
- 140.12. Go (im_go)
- 140.13. HTTP(s) (im_http)
- 140.14. Internal (im_internal)
- 140.15. Java (im_java)
- 140.16. Kafka (im_kafka)
- 140.17. Kernel (im_kernel)
- 140.18. Linux Audit System (im_linuxaudit)
- 140.19. macOS ULS (im_maculs)
- 140.20. Mark (im_mark)
- 140.21. Event Logging for Windows XP/2000/2003 (im_mseventlog)
- 140.22. Event log for Windows 2008/Vista and later (im_msvistalog)
- 140.23. Null (im_null)
- 140.24. ODBC (im_odbc)
- 140.25. Packet capture (im_pcap)
- 140.26. Perl (im_perl)
- 140.27. Named pipes (im_pipe)
- 140.28. Python (im_python)
- 140.29. Redis (im_redis)
- 140.30. Windows Registry Monitoring (im_regmon)
- 140.31. Ruby (im_ruby)
- 140.32. TLS/SSL (im_ssl)
- 140.33. Systemd (im_systemd)
- 140.34. TCP (im_tcp)
- 140.35. Test Generator (im_testgen)
- 140.36. UDP (im_udp)
- 140.37. Unix domain sockets (im_uds)
- 140.38. Windows Performance Counters (im_winperfcount)
- 140.39. Windows Event Collector (im_wseventing)
- 140.40. ZeroMQ (im_zmq)
- 141. Processor Modules
- 142. Output Modules
- NXLog Manager
- NXLog Add-Ons
The im_batchcompress module provides a compressed network transport with optional SSL encryption. It uses its own protocol to receive and decompress a batch of messages sent by om_batchcompress.
|To examine the supported platforms, see the list of installer packages in the Available Modules chapter.|
The im_batchcompress module accepts the following directives in addition to the common module directives.
The module accepts connections on the IP address or hostname and port defined here. The default address is
localhostand the default port is 2514. 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). The port section of this directive and the Port directive are mutually exclusive. In case both is 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 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.
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 listens for incoming connections on the port defined in this directive. The default is port 2514.
|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 boolean directive specifies whether the remote connection should be allowed without certificate verification. If set to TRUE the remote will be able to connect with an unknown or self-signed certificate. The default value is FALSE: by default, all connections must present a trusted certificate.
This specifies the path to a directory containing certificate authority (CA) certificates, which will be used to check the certificate of the remote socket. The certificate filenames in this directory must be in the OpenSSL hashed format. A remote’s self-signed certificate (which is not signed by a CA) can also be trusted by including a copy of the certificate in this directory.
This specifies the path of the certificate authority (CA) certificate, which will be used to check the certificate of the remote socket. To trust a self-signed certificate presented by the remote (which is not signed by a CA), provide that certificate instead.
This optional directive specifies the certificate thumbprint of the certificate authority (CA), which is used to look up the CA certificate from the Windows certificate store. The hexadecimal fingerprint string can be copied straight from Windows Certificate Manager (certmgr.msc), whitespaces are automatically removed. This directive is only supported on Windows. This directive and the CADir and CAFile directives are mutually exclusive.
This specifies the path of the certificate file to be used for the SSL handshake.
This specifies the path of the certificate key file to be used for the SSL handshake.
This optional directive specifies the certificate thumbprint to be used for the SSL handshake. The hexadecimal fingerprint string can be copied straight from Windows Certificate Manager (certmgr.msc), whitespaces are automatically removed. This directive is only supported on Windows. This directive and the CertFile and CertKeyFile directives are mutually exclusive.
This specifies the path to a directory containing certificate revocation lists (CRLs), which will be consulted when checking the certificate of the remote socket. The filenames in this directory must be in the OpenSSL hashed format.
This specifies the path of the certificate revocation list (CRL) which will be consulted when checking the certificate of the remote socket.
With this directive, a password can be supplied for the certificate key file defined in CertKeyFile. This directive is not needed for passwordless private keys.
This boolean directive specifies that the remote must present a certificate. If set to TRUE and there is no certificate presented during the connection handshake, the connection will be refused. The default value is TRUE: by default, each connections must use a certificate.
This optional directive can be used to set the permitted SSL cipher list, overriding the default. Use the format described in the ciphers(1ssl) man page.
|If RSA or DSA ciphers with Diffie-Hellman key exchange are used, DHFile can be set for specifying custom dh-parameters.|
This directive can be used to set the allowed SSL/TLS protocol(s). It takes a comma-separated list of values which can be any of the following:
TLSv1.3. By default, the
TLSv1.3protocols are allowed. Note that the OpenSSL library shipped by Linux distributions may not support
SSLv3, and these will not work even if enabled with this directive.
The following fields are used by im_batchcompress.
The IP address of the remote host.
Pre-v5 syntax examples are included, they will become invalid with NXLog EE 6.0.
This configuration listens on port 2514 for incoming log batches and writes them to file.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 <Input batchcompress> Module im_batchcompress ListenAddr 0.0.0.0:2514 </Input> # Using the syntax prior to NXLog EE 5, # where the port is defined in a separate directive. #<Input batchcompress> # Module im_batchcompress # ListenAddr 0.0.0.0 # Port 2514 #</Input> <Output file> Module om_file File "tmp/output" </Output> <Route batchcompress_to_file> Path batchcompress => file </Route>