Unix Domain Sockets (om_uds)
This module allows log messages to be sent to a Unix domain socket. Unix systems traditionally have a /dev/log or similar socket used by the system logger to accept messages. Applications use the syslog(3) system call to send messages to the system logger. NXLog can use this module to send log messages to another syslog daemon via the socket.
|This module supports SOCK_DGRAM type sockets only. SOCK_STREAM type sockets may be supported in the future.|
The om_uds module accepts the following directives in addition to the common module directives.
This specifies the path of the Unix domain socket. The default is
Use this directive to set the group ownership for the created socket or pipe or file. By default, this is the group NXLog is running as, (which may be specified by the global Group directive). This directive is not currently supported on Windows.
This directive specifies the permissions to use for the created socket or pipe or file. This must be a four-digit octal value beginning with a zero. By default, OS default permissions will be set. This directive is not currently supported on Windows.
This directive specifies the domain socket type. Supported values are
auto. The default is
Use this directive to set the user ownership for the created socket or pipe or file. By default, this is the user NXLog is running as (which may be specified by the global User directive). This directive is not currently supported on Windows.
See the OutputType directive in the list of common module directives. If UDSType is set to
Dgramor is set to
autoand a SOCK_DGRAM type socket is detected, this defaults to
Dgram. If UDSType is set to
streamor is set to
autoand a SOCK_STREAM type socket is detected, this defaults to
This configuration reads log messages from a file, adds BSD Syslog headers with default fields, and writes the messages to socket.
<Extension syslog> Module xm_syslog </Extension> <Input file> Module im_file File "/var/log/custom_app.log" </Input> <Output uds> Module om_uds # Defaulting Syslog fields and creating Syslog output Exec parse_syslog_bsd(); to_syslog_bsd(); UDS /dev/log </Output> <Route file_to_uds> Path file => uds </Route>