- OS Support
- Enterprise Edition Reference Manual
- 129. Man Pages
- 130. Configuration
- 131. Language
- 132. Extension Modules
- 133. Input Modules
- 134. Processor Modules
- 135. Output Modules
- 135.1. Batched Compression (om_batchcompress)
- 135.2. Blocker (om_blocker)
- 135.3. DBI (om_dbi)
- 135.4. Elasticsearch (om_elasticsearch)
- 135.5. EventDB (om_eventdb)
- 135.6. Program (om_exec)
- 135.7. Files (om_file)
- 135.8. Go (om_go)
- 135.9. HTTP(s) (om_http)
- 135.10. Java (om_java)
- 135.11. Kafka (om_kafka)
- 135.12. Null (om_null)
- 135.13. ODBC (om_odbc)
- 135.14. Perl (om_perl)
- 135.15. Named Pipes (om_pipe)
- 135.16. Python (om_python)
- 135.17. Raijin (om_raijin)
- 135.18. Redis (om_redis)
- 135.19. Ruby (om_ruby)
- 135.20. Microsoft Azure Sentinel (om_sentinel)
- 135.21. TLS/SSL (om_ssl)
- 135.22. TCP (om_tcp)
- 135.23. UDP (om_udp)
- 135.24. UDP with IP Spoofing (om_udpspoof)
- 135.25. Unix Domain Sockets (om_uds)
- 135.26. WebHDFS (om_webhdfs)
- 135.27. ZeroMQ (om_zmq)
- NXLog Manager
- NXLog Add-Ons
This module uses its own protocol to send batches of log messages to a remote NXLog instance configured with the im_batchcompress module. The messages are compressed in batches in order to achieve better compression ratios than would be possible individually. The module serializes and sends all fields across the network so that structured data is preserved. It can be configured to send data using SSL for secure and encrypted data transfer. The protocol contains an acknowledgment in order to ensure that the data is received by the remote server. The batch will be resent if the server does not respond with an acknowledgment.
Starting with NXLog version 5.2, this module takes advantage of an internal batch processing mechanism which is provided by the NXLog core.
Internal batching works by accumulating multiple successive event records produced by an input or processor module into a batch of records. When a batch is full or after a configurable timeout expires, the batch is forwarded to the next module in the route. For it’s own batching functionality, the om_batchcompress module now uses the already available batches it receives from the previous module, instead of reorganizing individual event records into batches itself.
Simply put, the new batching functionality works the same as before, with the difference that event records are organized into batches by input and processor modules, whereas in older versions, it was the output modules which did this. Because of this, the FlushInterval and FlushLimit configuration directives have been deprecated for om_batchcompress. The same functionality is now provided by the BatchFlushInterval and BatchSize directives, which can be used with all input and processor module(s).
|To examine the supported platforms, see the list of installer packages in the Available Modules chapter.|
The module connects to the IP address or hostname defined in this directive. If additional hosts are specified on new lines, the module works in a failover configuration. If a destination becomes unavailable, the module automatically fails over to the next one. If the last destination becomes unavailable, the module will fail over to the first destination.
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). For each destination with no port number defined here, the port number specified in the Port directive is used. Port numbers defined here take precedence over any port number defined in the Port directive.
The module connects to the port number on the destination host defined in this directive. This configuration is only used for any destination that does not have a port number specified in the Host directive. If no port is configured for a destination in either directive, the default port is used, which is port 2514.
|The Port directive will become deprecated from NXLog EE 6.0. After that, the port can only be defined in the Host directive.|
This boolean directive specifies that the remote connection should be allowed without certificate verification. If set to TRUE the remote will be able to connect with unknown and self-signed certificates. The default value is FALSE: 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 certificate 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.
This directive has been deprecated. See Batch processing for details.
This directive has been deprecated. See Batch processing for details.
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 optional directive specifies the local port number of the connection. If this is not specified a random high port number will be used, which is not always ideal in firewalled network environments.
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.
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.
This boolean directive specifies that SSL transfer mode should be enabled. The default is FALSE.
Pre-v5 syntax examples are included, they will become invalid with NXLog EE 6.0.
This configuration forwards logs in compressed batches to a remote NXLog agent over the default port. Batches are sent at least once every two seconds, or more frequently if the buffer reaches 100 events.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 <Input null> Module im_null BatchSize 200 BatchFlushInterval 2 </Input> <Output batchcompress> Module om_batchcompress Host example.com:2514 </Output> # Example using the syntax used before NXLog EE 5, # where the port is defined in a separate directive. #<Output batchcompress> # Module om_batchcompress # Host example.com # Port 2514 #</Output> <Route null_to_batchcompress> Path null => batchcompress </Route>
This configuration sends logs in compressed batches to a remote NXLog agent in a failover configuration (multiple Hosts defined).