The gather_update_log_stats Script

Valid for versions 82 through the latest version

Version:

82


Last modified: August 16, 2021

Overview

Important:

For more information about the cPanel Analytics data that we gather and how we use it, read our cPanel Analytics documentation and our Server Usage Analysis Data Collection Policy.

The /usr/local/cpanel/scripts/gather_update_log_stats script gathers your server’s update logs and sends them to cPanel, L.L.C. for analysis. Whenever the gather_update_log_stats script runs, it creates a tarball file to send. This tarball contains all of the update log data that the system stored since your last update.

  • The /var/cpanel/updatelogs directory contains the system’s uncompressed update log files.
  • The /usr/local/cpanel/logs/update_analysis directory stores the .tar.gz files that the system will send.
Note:
  • If you run this script while the upcp is running, the system will schedule this script to run when the upcp script finishes.
  • If you run this script, but update log gathering is disabled, the server will only send system data.
  • The gather_update_logs_setupcrontab script sets up a cron job to run the gather_update_log_stats script.
  • Servers that run cPanel & WHM version 94.0.16 and older and do not update system software (the yum update command) will use the legacy method of reporting analytics. The legacy method uses the upcp script to run the gather-update-logs script.
  • For more information about these log files, read our The cPanel Log Files documentation.

Run the script

To run this script on the command line, use the following format:

/usr/local/cpanel/scripts/gather_update_log_stats --upload --logfile /var/cpanel/updatelogs/2021-11-07T08:15:06Z.log

Options

Use the following options with this script:

Options Description Example
--upload Whether to send the specified tarball. --upload
--logfile The full path to a upcp logfile to analyze. If you do not use this option, the script will create a tarball based on the current system date. --logfile /var/cpanel/updatelogs/2021-11-07T08:15:06Z.log
--help Display the script’s help documentation. --help

Several settings exist in WHM’s Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings) to enable, disable, or customize this functionality. We disable these settings by default.

  • To set the number of days to retain log files before deletion, use the Update analysis retention interval setting in the Support section.
  • To set whether the system sends anonymized data about your server configuration, use the Send error reports to cPanel for analysis setting in the Support section.
  • To set whether the system sends anonymized data about how you and your users use cPanel & WHM, use the Send information about server usage to cPanel for analysis setting in the Support section.
  • To change the number of days to retain these logs, use the Number of days to retain upcp logs before purging them setting in the Stats and Logs section.

Additional Documentation