nxlog-processor(8)

NAME

nxlog-processor - collects, processes, converts, and forwards telemetry data in many different formats

SYNOPSIS

nxlog-processor [-c conffile] [-v]

DESCRIPTION

The nxlog-processor tool is similar to the NXLog Agent service and uses the same configuration file. However, it runs in the foreground and exits after it finishes processing the input data. Common input sources include files and databases. This tool is useful for data processing tasks such as:

  • Migrating data from files to a database

  • Converting between different data formats

  • Testing patterns

  • Correlating events offline

  • Checking HMAC message integrity

The details provided here primarily apply to NXLog Agent installations on Linux and UNIX systems. However, NXLog Agent can also be installed on Windows, and some Windows-specific notes are included.

OPTIONS

-c conffile, --conf conffile

Specify an alternative configuration file conffile.

-h, --help

Print help.

-v, --verify

Verify the configuration file syntax.

FILES

/opt/nxlog/bin/nxlog-processor

The main nxlog-processor executable.

/opt/nxlog/bin/nxlog-stmnt-verifier

A tool that reads input from the standard input stream and checks if it’s a valid NXLog language statement. If a statement is invalid, the tool prints an error to the standard error stream and exits with a non-zero value.

/opt/nxlog/etc/nxlog.conf

The default configuration file.

/opt/nxlog/spool/nxlog/configcache.dat

The cache file that stores the last read position. You can turn off position caching by setting the NoCache directive to TRUE.

ENVIRONMENT

To access environment variables from the NXLog Agent configuration, use the envvar directive.

SEE ALSO

NXLog website: https://nxlog.co

NXLog Platform User Guide: https://docs.nxlog.co/platform/current/

Copyright © NXLog Ltd. 2025

A commercial license is required to use NXLog Agent. Visit the NXLog website for more information.