Valid for versions 94 through the latest version
Last modified: October 19, 2022
Overview
Important:
- We removed this script in cPanel & WHM version 94. The system now uses the gather_update_log_stats script to send Analytics data to cPanel, L.L.C.
- We recommend that you do not run this script manually.
- 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 servers 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/updatelogsdirectory contains the systems uncompressed update log files. - The
/usr/local/cpanel/logs/update_analysisdirectory stores the.tar.gzfiles that the system will send.
Note:
- If you run this script but have not enabled update log gathering, the system will not send information about error logs, update blockers, or the Site Publisher feature.
- 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
Options
Use the following options with this script:
| Options | Description | Example |
|---|---|---|
--upload |
Whether to send the specified tarball.
|
--upload 1 |
--list |
List the existing tarballs on the server.
|
--list |
--gather |
Immediately gather a tarball based on the current system state. | --gather |
--send |
Specify an existing tarball to send to cPanel, L.L.C. for analysis. This tarballs filename must match the following regular expression:m/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z\.tar\.gz$/ |
--send 2018-11-07T08:15:06Z.tar.gz |
Related settings
Several settings exist in WHMs 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 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.
