NXLog Legacy Documentation

Named Pipes (om_pipe)

This module allows log messages to be sent to named pipes on UNIX-like operating systems.

The om_pipe module accepts the following directives in addition to the common module directives.

Pipe: This mandatory directive specifies the name of the output pipe file. The module checks if the specified pipe file exists and creates it in case it does not. If the specified pipe file is not a named pipe, the module does not start.

Group: 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.

Perms: 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.

User: 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.

OutputType: This directive specifies the input data format. The default value is LineBased. See the OutputType directive in the list of common module directives.

This example provides the NXLog configuration for forwarding messages to a named pipe on a UNIX-like operating system.

Example 1. Forwarding Logs From a File to a Pipe

With this configuration, NXLog reads messages from a file and forwards them to a pipe. No additional processing is done.

nxlog.conf

<Input in>
    Module    im_file
    File      "/tmp/input"
</Input>

<Output out>
    Module    om_pipe
    Pipe      "/tmp/output"
</Output>