- OS Support
- Enterprise Edition Reference Manual
- 132. Man Pages
- 133. Configuration
- 134. Language
- 135. Extension Modules
- 136. Input Modules
- 137. Processor Modules
- 138. Output Modules
- 138.1. Batched Compression (om_batchcompress)
- 138.2. Blocker (om_blocker)
- 138.3. DBI (om_dbi)
- 138.4. Elasticsearch (om_elasticsearch)
- 138.5. EventDB (om_eventdb)
- 138.6. Program (om_exec)
- 138.7. Files (om_file)
- 138.8. Go (om_go)
- 138.9. HTTP(s) (om_http)
- 138.10. Java (om_java)
- 138.11. Kafka (om_kafka)
- 138.12. Null (om_null)
- 138.13. ODBC (om_odbc)
- 138.14. Perl (om_perl)
- 138.15. Named Pipes (om_pipe)
- 138.16. Python (om_python)
- 138.17. Raijin (om_raijin)
- 138.18. Redis (om_redis)
- 138.19. Ruby (om_ruby)
- 138.20. Microsoft Azure Sentinel (om_azure)
- 138.21. TLS/SSL (om_ssl)
- 138.22. TCP (om_tcp)
- 138.23. UDP (om_udp)
- 138.24. UDP with IP Spoofing (om_udpspoof)
- 138.25. Unix Domain Sockets (om_uds)
- 138.26. WebHDFS (om_webhdfs)
- 138.27. ZeroMQ (om_zmq)
- NXLog Manager
- NXLog Add-Ons
This module allows logs to be stored in Hadoop HDFS using the WebHDFS protocol.
|To examine the supported platforms, see the list of installer packages in the Available Modules chapter.|
This mandatory directive specifies the name of the destination file. It must be a string type expression. If the expression in the File directive is not a constant string (it contains functions, field names, or operators), it will be evaluated before each request is dispatched to the WebHDFS REST endpoint (and after the Exec is evaluated). Note that the filename must be quoted to be a valid string literal, unlike in other directives which take a filename argument.
This mandatory directive specifies the URL of the WebHDFS REST endpoint where the module should POST the event data. The module operates in plain HTTP or HTTPS mode depending on the URL provided, and connects to the hostname specified in the URL. If the port number is not explicitly indicated in the URL, it defaults to port 80 for HTTP and port 443 for HTTPS.
When the number of events in the output buffer reaches the value specified by this directive, the module will send the data to the endpoint defined in URL. This defaults to 500 events. The FlushInterval may trigger sending the write request before this limit is reached if the log volume is low to ensure that data is sent promptly.
This boolean directive specifies that the connection should be allowed without certificate verification. If set to TRUE, the connection will be allowed even if the remote HTTPS server presents an unknown or self-signed certificate. The default value is FALSE: the remote 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 HTTPS server. 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 HTTPS server. 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 HTTPSCADir and HTTPSCAFile directives are mutually exclusive.
This specifies the path of the certificate file to be used for the HTTPS handshake.
This specifies the path of the certificate key file to be used for the HTTPS 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 HTTPSCertFile and HTTPSCertKeyFile 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 HTTPS server. 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 HTTPS server.
With this directive, a password can be supplied for the certificate key file defined in HTTPSCertKeyFile. This directive is not needed for passwordless private keys.
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 optional directive can be used to define the permitted SSL cipher list in case the HTTPSSSLProtocol directive is set to
TLSv1.3. Use the same format as in the HTTPSSSLCipher directive.
This boolean directive allows you to enable data compression when sending data over the network. The compression mechanism is based on the zlib compression library. If the directive is not specified, it defaults to FALSE (the compression is disabled).Note
Some Linux packages (for example, Debian) use the OpenSSL library provided by the OS and may not support the zlib compression mechanism. The module will emit a warning on startup if the compression support is missing. The generic deb/rpm packages are bundled with a zlib-enabled libssl library.
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 configuration option can be used to specify additional HTTP Query Parameters such as BlockSize. This option may be used to define more than one parameter:
QueryParam blocksize 42 QueryParam destination /foo
This optional directive sets the reconnect interval in seconds. If it is set, the module attempts to reconnect in every defined second. If it is not set, the reconnect interval will start at 1 second and doubles with every attempt. If the duration of the successful connection is greater than the current reconnect interval, then the reconnect interval will be reset to 1 sec.
|The Reconnect directive must be used with caution. If it is used on multiple systems, it can send reconnect requests simultaneously to the same destination, potentially overloading the destination system. It may also cause NXLog to use unusually high system resources or cause NXLog to become unresponsive.|
The following procedures are exported by om_webhdfs.
Force a reconnection. This can be used from a Schedule block to periodically reconnect to the server.Caution
The reconnect() procedure must be used with caution. If configured, it can attempt to reconnect after every event sent, potentially overloading the destination system.