NXLog User Guide
- 5. Supported platforms
- 6. Product life cycle
- 7. System requirements
- 8. NXLog digital signature verification
- 9. Red Hat Enterprise Linux & CentOS
- 10. Debian & Ubuntu
- 11. SUSE Linux Enterprise Server
- 12. FreeBSD
- 13. OpenBSD
- 14. Microsoft Windows
- 15. Microsoft Nano Server
- 16. Apple macOS
- 17. Docker
- 18. IBM AIX
- 19. Oracle Solaris
- 20. Hardening NXLog
- 21. Relocating NXLog
- 22. Monitoring and recovery
- OS Support
- Enterprise Edition Reference Manual
- NXLog Manager
- NXLog Add-Ons
This topic describes the steps to install and upgrade NXLog on Red Hat Enterprise Linux and its derivatives.
First, download the appropriate NXLog installation file from the NXLog website.
Log in to your account, then click My account at the top of the page.
Under thetab, download the correct file for the target platform.
Table 51. Available RHEL/CentOS Files Platform Archive
RHEL 6 or CentOS 6
RHEL 7 or CentOS 7
RHEL 8 or CentOS 8
The RHEL 6, RHEL 7 and RHEL 8 archives above each contain several RPMs (see Packages in a RHEL Archive below). These RPMs have dependencies on system-provided RPMs.
The generic RPM above contains all the libraries (such as libpcre and libexpat) that are needed by NXLog. The only dependency is libc. However, some modules are not available (im_checkpoint, for example). The advantage of the generic RPM is that it can be installed on most RPM-based Linux distributions.
Transfer the file to the target server using SFTP or a similar secure method.
Log in to the target server and extract the contents of the archive (unless you are using the generic package):
# tar -xf nxlog-5.4.7313_rhel7.x86_64.tar.bz2
Table 52. Packages in a RHEL Archive Package Description
The main NXLog package
Provides the im_checkpoint module
nxlog-dbi-5.4.7313_rhel7.x86_64.rpm (available for RHEL 6 and RHEL 7 only)
Provides the im_pcap module
Provides the im_systemd module
Provides the im_wseventing module
Optional: To change the NXLog user and group for the installation, set the
NXLOG_GROUPenvironment variables. During installation a new user and and a new group will be created based on these environment variables. They will be used for User and Group directives in
nxlog.conf, and for the ownership of some directories under
/opt/nxlog. Specifying an already existing user or group is not supported. The created user and group will be deleted on NXLog removal.
# export NXLOG_USER=nxlog2 # export NXLOG_GROUP=nxlog2
Download the public key file from the NXLog’s public contrib repository and import it to the RPM database.
# rpm --import nxlog-pubkey.ascNote
For more details about the package verification, see the Signature Verification for RPM Packages section in the User Guide.
If you are installing the
nxlog-zmqpackage, enable the EPEL repository so ZeroMQ dependencies will be available:
# yum install -y epel-release
Use yum to install the required NXLog packages (or the generic package) and dependencies.
# yum install nxlog-5.4.7313_rhel7.x86_64.rpm
Configure NXLog by editing
/opt/nxlog/etc/nxlog.conf. General information about configuring NXLog can be found in Configuration. For more details about configuring NXLog to collect logs on Linux, see the GNU/Linux summary.
Verify the configuration file syntax.
# /opt/nxlog/bin/nxlog -v 2017-03-17 08:05:06 INFO configuration OK
Start the service using the
# service nxlog start
Check that the NXLog service is running.
# service nxlog status nxlog (pid 9218) is running...
To upgrade an NXLog installation to the latest release, or to replace a trial installation of NXLog Enterprise Edition with a licensed copy, use yum as in the installation instructions above. It is recommended to make a backup of the configuration files before starting this process.
# yum install nxlog-5.4.7313_rhel7.x86_64.rpm
|The same procedure is used to upgrade from NXLog Community Edition to NXLog Enterprise Edition. However, in such case, you will need to manually copy the previous configuration to the new installation.|
|The same user and group will be used for the upgrade as was used for the original installation (see installation step 4 above). Changing to a different user and group during upgrade is not supported.|
To uninstall NXLog, use
yum remove. To remove any packages
that were dependencies of NXLog but are not required by any
other packages, include the
option. Verify the operation before confirming!
# yum remove 'nxlog-*'
This procedure may not remove all files that were created
while configuring NXLog. Likewise, any files created as
a result of NXLog’s logging operations will not be removed.
To find these files, examine the configuration files that were
used with NXLog and check the installation directory