Statistics Software Configuration

Valid for versions 82 through the latest version

Version:

82


Last modified: December 1, 2022

Overview

This interface displays information about your server’s statistics and statistics software. cPanel & WHM servers include three statistics applications (generators): Analog, AWStats, and Webalizer.

Note:

The /usr/local/cpanel/logs/stats_log file contains the statistics logs for your server. If your server experiences problems when it processes statistics, the log file may provide additional information to troubleshoot the issue.

Statistics Status Summary

This section of the interface allows you to view important information about your server’s statistics software.

Show which users are behind

Note:

This option only appears if cPanel accounts exist that process statistics behind the server’s statistics process schedule. If a cPanel account processes statistics behind the server’s schedule, a message about the problem also appears.

To display a list of these cPanel users, click Show which users are behind. A table will appear that displays cPanel users and the number of minutes behind schedule that their accounts process statistics.

See the Statistics Summary of a Specific User

To view your cPanel accounts’ statistics process summaries, perform the following steps:

  1. Select All or a specific cPanel user from the User to Display menu.
  2. Click Go. A new interface appears that displays the account’s statistics process information, as well as specific information for each of the three statistics generators.
  3. Click Details to view a statistics generator’s information. A new interface will appear that displays the following information:
    • Whether the statistics generator is enabled or disabled.
    • Whether the statistics generator’s Global Generator Defaults setting is enabled or disabled.
      • Click Change to return to the main Statistics Software Configuration interface.
      • Use the Generators Configuration section of the interface to modify that user’s permissions.
    • Whether the root user grants the user permission to change the statistics generator configuration.
      • Click Change to return to the main Statistics Software Configuration interface.
      • Use the User Permissions section of the interface to modify that user’s permissions.
    • Whether the root user grants the user permission to change any generator’s status from the default.
      • Click Change to log in to cPanel as the user that you selected and navigate to cPanel’s Metrics Editor interface (cPanel » Home » Metrics » Metrics Editor).

Process Statistics for User

This section of the interface allows you to process individual cPanel accounts’ statistics. The process runs in the background and stores the results while you continue to work in WHM. When the process finishes, you can view these statistics from the user’s cPanel interface.

To process a user’s statistics, select the user from the User to Process menu and click Go.

Generators Configuration

This section of the interface allows you to select your cPanel users’ statistical analysis software.

Select the appropriate checkboxes to configure the following statistics: Analog, AWStats, and Webalizer.

  • Select the appropriate Available to Users checkbox to make the software available to all of your cPanel users who have the ability to change their web statistics software.
    Note:

    cPanel users must also enable the program in cPanel’s Metrics Editor interface (cPanel » Home » Metrics » Metrics Editor) to view their website’s statistics.

  • Select the appropriate Active by Default checkbox to make the software the default software for all of your cPanel users.
  • Select the Allow Awstats configuration Include file checkbox to customize users’ AWStats configurations. Then, add the configuration file to the user’s ~/tmp/awstats/awstats.conf.include/ directory. For more information, read the ASWstats SourceForge page.

User Permissions

This section of the interface allows you to specify which cPanel users can modify their statistics software.

Allow all users to change their web statistics generating software

To allow all of your cPanel users to modify their statistics software, select the Allow all users to change their web statistics generating software checkbox and click Save.

Choose Users

To select specific cPanel users who can modify their statistics software, perform the following steps:

  1. Click Choose Users. A new interface will appear.
  2. Configure the Allowed Users menu.
    • To allow a user to select which software to use, select the account name from the Available Users menu and click Add, or click Add All to add all users to the Allowed Users menu.
    • To remove an account holder, select the user in the Allowed Users menu and click Remove, or click Remove All to remove all users from the Allowed Users menu.
  3. WHM automatically saves each change that you make to the Allowed Users menu. After you make your changes, click Go Back.

Choose Specific Stats Programs

To choose a cPanel user’s specific statistics generators, perform the following steps:

  1. Click Choose Users. A new interface will appear.
  2. Enter the user’s name in the Choose Speficic Stats Programs for text box and click Configure.
  3. Select the checkbox next to each generator that you wish to make available to the user.
  4. Click Save.

Schedule Summary

This section of the interface displays the estimated update schedule for each statistics software.

Schedule Configuration

This section of the interface allows you to use the following settings to determine how often WHM processes the statistics on your server:

  • Log Processing Frequency — Enter the number of hours after which WHM processes log files for your server.
  • Bandwidth Processing Frequency — Enter the number of hours after which WHM processes bandwidth statistics for your server.
Notes:
  • Set these intervals in increments of 0.25 (which represents 15 minutes). For example, 4.25 specifies an interval of four hours and fifteen minutes.
  • We recommend that you do not set the Log Processing Frequency setting to a number below 24. Lower numbers may prevent the successful completion of the log process schedule.

Configure Statistic Process Time Schedule

To define a more precise schedule, perform the following steps:

  1. Click Configure Statistic Process Time Schedule.
  2. In the new interface that appears, select the hours in which your server will not perform log analysis.
    Important:

    Only process statistics at off-peak hours, when your server processes fewer requests.

  3. To ensure that backups and log analysis do not occur simultaneously, select the Prevent cpanellogd (Log Processing) and cpbackup (Backups) from running at the same time checkbox.
  4. Click Save.
Notes:
  • If your server is very busy, your system may require more than one hour to fully analyze log files. Make certain that you leave an adequate number of hours unselected to allow sufficient time for log analysis.
  • The times that you select only affect the Analog, AWStats, and Webalizer statistics programs. This schedule does not control how the cpanellogd daemon processes bandwidth statistics internally, which is necessary for bandwidth reports in cPanel & WHM. The cpanellogd daemon may still process statistics in blackout hours, and uses minimal resources. The Bandwidth Processing Frequency setting still controls the frequency with which the cpanellogd daemon processes data.
  • The Extra CPUs for server load setting in the Stats and Logs section of WHM’s Tweak Settings interface (WHM » Home » Server Configuration » Tweak Settings) also affects how to server processes statistics. If the system does not process statistics in the allotted time, we recommend that you increase this value.

Additional Documentation