Create a Support Package
This guide explains how to generate a support package for troubleshooting error scenarios.
The support package script can be used to collect information about your system for troubleshooting and debugging issues.
The script collects system and service information and then packages the data into a tar archive, which you can share with NGINX Customer Support.
The NGINX Instance Manager installer copies the
support-package.sh script to the following location:
To create a support package:
Run the support package script. The script requires root privileges to run.
sudo bash /etc/nms/scripts/support-package.sh
The support package is saved in the same location from where the script was run (if no
-targument is passed).
(Optional) If you use a different Instance Manager config file than the default
/etc/nms/nms.conffile, run the support package script with the
-cflag and specify the path to your config file:
sudo bash /etc/nms/scripts/support-package.sh -c /your/config.conf
To extract the package, use the
tar -xvf support-pkg-<timestamp>.tar.gz
The supported shell is
The following table lists the arguments you can use with the support package script.
|Prints information about the script arguments to stdout.
|The output directory where the tar archive is saved.
|The directory where the NGINX log files are located.
|The path to the Instance Manager config file.
|The directory where the Instance Manager log file is located.
|The Instance Manager address (host:port).
|Excludes database data from the support package.
|Excludes timeseries data from the support package.
The support package includes several directories containing information about the system, service, and database state.
The information included is based on the NGINX products installed and configured.
The access and error logs of the instances that Instance Manager monitors.
The access logs display the HTTP traffic for Instance Manager that’s routed by the NGINX instance. The error log contains NGINX errors that occurred during runtime.
The logs of the Instance Manager processes.
You can pipe the logs to
grep to view entries belonging to only one of the three
nms processes. For example, to view
nms-core logs, run the following command:
cat nms.log | grep 'COR'
The following table shows the
nms processes and pattern to
Information about the Instance Manager and NGINX services running on the host. For each
nms process and the
nginx instance, the script collects:
journalctl(10000 most recent rows)
The status and state information of the host running Instance Manager, including the following:
- System metrics (memory usage, CPU usage, etc.)
- File permissions of the Instance Manager
- Firewall or SELinux state
- Network interfaces
- Network information (hostname, iptables)
- Environment variables
- Disk usage of select directories
- Operating system version
- Installed Instance Manager version
- Instance Manager license
The support package script uses the
-c flag ( or
--nms_config_path) to get the Instance Manager configuration. If the configuration file is not specified, the script uses the default value
If the Instance Manager configuration file does not specify addresses for the
dpmdatabases, the default values are assumed:
The support package script uses a small Go executable file called
dqlite-backup (located in
/etc/nms/scripts/) to connect to the databases and generate data dumps.
The collected data is saved to the directories
Additional directories may be created if other products are installed:
dqlite/acm for NGINX API Connectivity Manager and
dqlite/adc for NGINX Application Delivery Manager, respectively.
This folder contains status information, dumps, and statistics for the
nms ClickHouse database. In particular, for metrics and events.