Raijin (om_raijin)
This module enables logs to be forwarded to Raijin Database servers for ingestion. It connects to the URL specified in the configuration in either HTTP or HTTPS mode. Raijin accepts HTTP POST requests with multiple JSON records in the request body, assuming that there is a target database table already created on the Raijin side. Although Raijin accepts structured data in flat JSON (i.e. a list of key-value pairs) format, it does not support JSON values comprised of nested data structures or other non-scalar data such as arrays and maps. Raijin currently does not support authorization/SSL but the om_raijin module supports TLS since TLS can be enabled with an HTTP proxy.
|
This module requires the xm_json extension module to be loaded to convert the payload to JSON. See the Output log format section for information on the payload format. |
Output log format
om_raijin forwards log records over HTTP(S) as JSON payload.
The JSON format depends on the value of the $raw_event field.
The module checks if the value of $raw_event is valid JSON and applies the following rules:
-
If it is valid JSON, the value is forwarded as is.
-
If it is not valid JSON, the log record is converted to JSON in the following format:
{ "raw_event": "<json_escaped_raw_event>" }
Additional metadata, including the NXLog-specific fields EventReceivedTime, SourceModuleName, and SourceModuleType, will not be included in the output unless these values have been written to the $raw_event field.
The processing required to achieve this depends on the format of the input data, but generally, it means you need to:
-
Parse the log record according to the data format.
-
If the input data is already in JSON format, use parse_json() to parse
$raw_eventinto fields. -
If the input is unstructured plain text data, copy the value of
$raw_eventto a custom field.
-
-
Create and populate any additional custom fields.
-
Use to_json() to convert the fields to JSON format and update the value of
$raw_event.
See the Examples section for NXLog configuration examples of the above.
Configuration
The om_raijin module accepts the following directives in addition to the common module directives.
Required directives
The following directives are required for the module to start.
This mandatory directive specifies the name of the Raijin database containing the table where logs will be stored. |
|||
This mandatory directive specifies the name of the database table where log events will be inserted as JSON records. |
|||
This mandatory directive is comprised of the REST API URI that Raijin Server uses for receiving bulk, JSON-formatted events via POST requests: If an om_raijin module instance contains multiple URL directives, the hosts will function as a cluster in NXLog failover mode.
This directive also supports HTTPS URLs.
If the optional port number part of the URL (
|
HTTPS directives
The following directives configure secure data transfer via HTTPS.
Specifies if the connection should be allowed with an expired certificate.
If set to |
|||
Specifies if the certificate FQDN should be validated against the server hostname or not.
If set to |
|||
Specifies if the connection should be allowed without certificate verification.
If set to |
|||
The path to a directory containing certificate authority (CA) certificates. These certificates will be used to verify the certificate presented by the remote host. The certificate files must be named using the OpenSSL hashed format, i.e. the hash of the certificate followed by .0, .1 etc. To find the hash of a certificate using OpenSSL: For example, if the certificate hash is A remote host’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. The default operating system root certificate store will be used if this directive is not specified.
Unix-like operating systems commonly store root certificates in In addition, Microsoft’s PKI repository contains root certificates for Microsoft services. |
|||
The path of the certificate authority (CA) certificate that will be used to verify the certificate presented by the remote host. A remote host’s self-signed certificate (which is not signed by a CA) can be trusted by specifying the remote host certificate itself. In case of certificates signed by an intermediate CA, the certificate specified must contain the complete certificate chain (certificate bundle). |
|||
This optional directive, supported only on Windows, defines a pattern for locating a suitable CA (Certificate Authority) certificate and its thumbprint in the native Windows Certificate Storage.
The pattern must follow PCRE2 rules and use the format Configuration examples: or A normal log output example would look like as follows: |
|||
This optional directive, supported only on Windows, specifies the thumbprint of the certificate authority (CA) certificate that will be used to verify the certificate presented by the remote host. The hexadecimal fingerprint string can be copied from Windows Certificate Manager (certmgr.msc). Whitespaces are automatically removed. The certificate must be added to a Windows certificate store that is accessible by NXLog. This directive is mutually exclusive with the HTTPSCADir and HTTPSCAFile directives. |
|||
The path of the certificate file that will be presented to the remote host during the HTTPS handshake. |
|||
The path of the private key file that was used to generate the certificate specified by the HTTPSCertFile directive. This is used for the HTTPS handshake. |
|||
This optional directive, supported only on Windows, defines a pattern for identifying a corresponding certificate and its thumbprint within the native Windows Certificate Storage.
The pattern must follow PCRE2 rules and use the format Configuration examples: or A normal log output example would look like as follows: |
|||
This optional directive, supported only on Windows, specifies the thumbprint of the certificate that will be presented to the remote host during the HTTPS handshake.
The hexadecimal fingerprint string can be copied from Windows Certificate Manager (certmgr.msc).
Whitespaces are automatically removed.
The certificate must be imported to the When the global directive UseCNGCertificates is set to
On the contrary, when the global directive UseCNGCertificates is set to The usage of the directive is the same in all cases: |
|||
The path to a directory containing certificate revocation list (CRL) files. These CRL files will be used to check for certificates that were revoked and should no longer be accepted. The files must be named using the OpenSSL hashed format, i.e. the hash of the issuer followed by .r0, .r1 etc. To find the hash of the issuer of a CRL file using OpenSSL: For example if the hash is |
|||
The path of the certificate revocation list (CRL) which will be used to check for certificates that have been revoked and should no longer be accepted. Example to generate a CRL file using OpenSSL: |
|||
This optional directive specifies a file with dh-parameters for Diffie-Hellman key exchange. These parameters can be generated with dhparam(1ssl). If no directive is specified, default parameters will be used. See OpenSSL Wiki for further details. |
|||
The passphrase of the private key specified by the HTTPSCertKeyFile directive. A passphrase is required when the private key is encrypted. Example to generate a private key with Triple DES encryption using OpenSSL: This directive is not needed for passwordless private keys. |
|||
If set to This directive is only supported on Windows. |
|||
Specifies if the remote HTTPS host must present a certificate.
If set to |
|||
This optional directive, if set to This directive is only supported on Windows. |
|||
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.
For example specify
|
|||
This optional directive can be used to set the permitted cipher list for TLSv1.3. Use the same format as in the HTTPSSSLCipher directive. Refer to the OpenSSL documentation for a list of valid TLS v1.3 cipher suites. The default value is:
|
|||
If set to
|
|||
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: |
|||
The signature algorithm parameter that is being sent to the Windows SSL library. Allowed values depend on the available encryption providers. This directive is only supported on Windows. |
|||
This optional directive specifies the hostname used for Server Name Indication (SNI) in HTTPS mode. If not specified, it defaults to the hostname in the URL directive. |
|||
If set to TRUE, the module uses the Windows Cryptography API: Next Generation (CNG) to access the private keys associated with certificates identified by a thumbprint. This directive is only supported on Windows. |
Optional directives
This directive has been deprecated. See Batch processing for details. |
|||
This directive has been deprecated. See Batch processing for details. |
|||
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.
|
|||
Specifies the IP address of the proxy server in case the module needs to connect to a Raijin Database server through a proxy.
|
|||
Specifies the port number required to connect to the proxy server. |
|||
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 double 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.
|
|||
This optional directive defines the behavior when the connection with the remote host is lost.
When set to |
|||
This optional directive specifies the hostname used for Server Name Indication (SNI) in HTTPS mode. If not specified, it defaults to the hostname in the URL directive. |
|||
This directive specifies the username that the incoming data are associated with. If authentication is enabled, then it will be also used in the authentication process. |
|||
This optional directive specifies the password for the user defined by |
Procedures
The following procedures are exported by om_raijin.
reconnect();-
Force a reconnection. This can be used from a Schedule block to periodically reconnect to the server.
The reconnect() procedure must be used with caution. If configured, it can attempt to reconnect after every event sent, potentially overloading the destination system.
Examples
This configuration reads log messages from a file and forwards them to a Raijin Database server deployed on localhost.
No further processing is done on the log records.
<Extension json>
Module xm_json
</Extension>
<Input file>
Module im_file
File '/var/log/myapp*.log'
</Input>
<Output raijin_local>
Module om_raijin
URL http://localhost:2500
DBName logdb
DBTable logs
</Output>The following is a log record sample read by NXLog.
Mar 24 15:58:53 pc1 systemd[1452]: tracker-store.service: Succeeded.The following is the JSON-formatted log record that will be sent to the Raijin Database server.
{
"raw_event": "Mar 24 15:58:53 pc1 systemd[1452]: tracker-store.service: Succeeded."
}This configuration reads log records from a file and adds a $Hostname metadata field.
Log records are converted to JSON using the to_json() procedure of the xm_json module before they are forwarded to the Raijin Database server.
<Extension json>
Module xm_json
</Extension>
<Input file>
Module im_file
File '/var/log/myapp*.log'
Exec $Hostname = hostname();
Exec $Message = $raw_event;
</Input>
<Output raijin_local>
Module om_raijin
URL http://localhost:2500
DBName logdb
DBTable logs
Exec to_json();
</Output>The following is a log record sample read by NXLog.
Mar 24 15:58:53 pc1 systemd[1452]: tracker-store.service: Succeeded.The following is the JSON-formatted log record that will be sent to the Raijin Database server.
{
"EventReceivedTime": "2021-03-24T16:52:20.457348+01:00",
"SourceModuleName": "file",
"SourceModuleType": "im_file",
"Hostname": "pc1",
"Message": "Mar 24 15:58:53 pc1 systemd[1452]: tracker-store.service: Succeeded."
}This configuration reads syslog records from a file. It uses the parse_syslog() procedure of the xm_syslog module to parse logs into structured data. Log records are then converted to JSON using the to_json() procedure of the xm_json module before they are forwarded to the Raijin Database server.
<Extension syslog>
Module xm_syslog
</Extension>
<Extension json>
Module xm_json
</Extension>
<Input file>
Module im_file
File '/var/log/myapp*.log'
Exec parse_syslog();
</Input>
<Output raijin_local>
Module om_raijin
URL http://localhost:2500
DBName logdb
DBTable logs
Exec to_json();
</Output>The following is a log record sample read by NXLog.
Mar 24 15:58:53 pc1 systemd[1452]: tracker-store.service: Succeeded.The following is the JSON-formatted log record that will be sent to the Raijin Database server.
{
"EventReceivedTime": "2021-03-24T16:30:18.920342+01:00",
"SourceModuleName": "file",
"SourceModuleType": "im_file",
"SyslogFacilityValue": 1,
"SyslogFacility": "USER",
"SyslogSeverityValue": 5,
"SyslogSeverity": "NOTICE",
"SeverityValue": 2,
"Severity": "INFO",
"Hostname": "pc1",
"EventTime": "2021-03-24T15:58:53.000000+01:00",
"SourceName": "systemd",
"ProcessID": 1452,
"Message": "tracker-store.service: Succeeded."
}This configuration reads JSON-formatted log records from a file.
It uses the parse_json() procedure of the xm_json module to parse logs into structured data and adds an $EventType metadata field.
Log records are then converted back to JSON using the to_json() procedure before they are forwarded to the Raijin Database server.
<Extension json>
Module xm_json
</Extension>
<Input file>
Module im_file
File '/var/log/myapp*.log'
Exec parse_json();
Exec $EventType = "browser-history";
</Input>
<Output raijin_local>
Module om_raijin
URL http://localhost:2500
DBName logdb
DBTable logs
Exec to_json();
</Output>The following is a log record sample read by NXLog.
{
"AccessTime": "2021-03-24T16:30:43.000000+01:00",
"URL": "https://nxlog.co",
"Title": "High Performance Log Collection Solutions",
"Username": "user1"
}The following is the JSON-formatted log record that will be sent to the Raijin Database server.
{
"EventReceivedTime": "2021-03-24T17:14:23.908155+01:00",
"SourceModuleName": "file",
"SourceModuleType": "im_file",
"AccessTime": "2021-03-24T16:30:43.000000+01:00",
"URL": "https://nxlog.co",
"Title": "High Performance Log Collection Solutions",
"Username": "user1",
"EventType": "browser-history"
}This configuration sends logs to a cluster of Raijin Database servers in NXLog failover mode.
The cluster is comprised of three hosts: http://raijin-1.example.com:2500, http://localhost:2500, and http://192.168.1.123:2500.
<Extension json>
Module xm_json
</Extension>
<Output raijin_cluster>
Module om_raijin
URL http://raijin-1.example.com:2500
URL http://localhost:2500
URL http://192.168.1.123:2500
DBName logdb
DBTable logs
</Output>
