Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
The gather-update-logs Script - Version 82 Documentation - cPanel Documentation
Page tree
For cPanel & WHM version 82.

Skip to end of metadata
Go to start of metadata



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-logs script gathers your server's update logs and sends them to cPanel, L.L.C. for analysis. Whenever the /usr/local/cpanel/scripts/upcp 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.


  • If you run this script but have not enabled update log gathering, the system won't have any data to send. For more information, read the Related settings section below.
  • 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-logs --upload 2018-11-07T08:15:06Z.tar.gz


Use the following options with this script:


Whether to send the specified tarball.

  • A value of 1 sends the tarball, while a value of 0 does not
  • This option defaults to 1.


If you use this option, you must also use the --send option.

--upload 1

List the existing tarballs on the server.

  • If you use this option, the script only returns the list of tarballs.
  • If no tarballs exist, the script does not return an error message.

Specify an existing tarball to send to cPanel, L.L.C. for analysis. This tarball's filename must match the following regular expression:

--send 2018-11-07T08:15:06Z.tar.gz

Related settings

Several settings exist in WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settingsto 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