1. cPanel & WHM Documentation
  2. WHM
  3. Scripts
  4. The gather_update_logs_setupcrontab Script
whmadvanced updates analytics

The gather_update_logs_setupcrontab Script

Valid for versions 82 through the latest version

Version:

82

Last modified: March 27, 2023

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 /scripts/the-gather_update_logs_setupcrontab-script script schedules a cron job to run the gather_update_log_stats script. The gather_update_log_stats script sends your server’s update logs to cPanel, L.L.C. for analysis.

Whenever the /usr/local/cpanel/scripts/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:
  • Servers that run cPanel & WHM version 94.0.14 and earlier 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/the-gather_update_logs_setupcrontab-script [off]

Options

Use the following options with this script:

Options Description Example
off The script will remove the cron entry. off
--help Display the script’s help documentation. --help

Additional Documentation