Page tree
Skip to end of metadata
Go to start of metadata

Important:

We released the first version of cPanel Analytics' Interface Analytics plugin in cPanel & WHM version 74. We released the full system in cPanel & WHM version 78.

Overview

cPanel Analytics features collect data about interface use and server configuration. We plan to use this information to improve the user experience in our products. 

We take your privacy very seriously. We have taken precautions to ensure that the data we collect is secure. We retain cPanel Analytics data for 26 months and then destroy it.

Important:

  • Configuration Analytics is required. Interface Analytics is optional.
  • We don't collect any Interface Analytics data until the root user enables this at the server level. Interface Analytics also doesn't collect data about specific accounts' use until that user enables data collection at the account level.
  • We strongly recommend that plugin developers also anonymize any collected data to respect user privacy.
  • Interface Analytics respects the dnt (Do Not Track) header. If you have disabled tracking in your browser, the feature will not collect data about you.

Interface Analytics

Interface Analytics allows us to collect data about how users navigate cPanel, WHM, and Webmail from within the interface. In cPanel & WHM version 78 and later, we automatically install the Interface Analytics plugin by default but do not enable it. The server owner and individual users must enable this before data collection begins.

When you enable Interface Analytics at the server level and users enable it at the account level, the plugin gathers several types of data. For more information, read our cPanel Analytics - The Data We Use documentation.

Note:

We do not track the content that exists on cPanel accounts. Additionally, the system removes URL-query parameters before cPanel, L.L.C. receives the data.

Enable or disable in cPanel & WHM version 78 or later

Enable or disable at the server level

To enable or disable Interface Analytics at the server level, use WHM's Configure cPanel Analytics interface (WHM >> Home >> Server Configuration >> Configure cPanel Analytics).

Enable or disable Interface Analytics at the account level

Remember:

The root user must enable Interface Analytics at the server level before users can enable Interface Analytics for their accounts.

To enable or disable cPanel Analytics' Interface Analytics feature for the current account, perform the following steps:

  1. Click the lightbulb () icon in the bottom right corner of the cPanel, WHM, or Webmail interface.
  2. Select the desired Interface Analytics setting:
    • Select Allow to enable data collection.
    • Select Deny to disable data collection.

Enable or disable in cPanel & WHM versions 74 and 76

Enable or disable cPanel Analytics features

With the exception of Interface Analytics, in cPanel & WHM version 74 and 76, you can enable or disable cPanel Analytics features in the Support section of WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings).

Enable or disable Interface Analytics at the server level

Important:

You must manually install and enable this plugin at the server level. Then, individual users can enable it to begin data collection for their account.

To install the cpanel-analytics plugin and enable Interface Analytics at the server level, run the following command as the root user:

yum install cpanel-analytics

When the /usr/local/cpanel/scripts/maintenance script runs, it checks for the /etc/yum.repos.d/cpanel-plugins.repo repository. It creates the repository if it does not exist. This repository contains the cPanel Analytics plugin as well as other cPanel-provided plugins.

Enable or disable Interface Analytics at the account level

After installing the cpanel-analytics plugin, a lightbulb () icon will appear in the cPanel, WHM, and Webmail interfaces.

Note:

This icon will also appear on the right side of each interface in cPanel & WHM and in Webmail.

To enable or disable Interface Analytics for the currently account, perform the following steps:

  1. Click the lightbulb icon.
  2. Select the desired Interface Analytics setting:
    • Select Allow to enable data collection.
    • Select Deny to disable data collection.

Configuration Analytics

Important:

Configuration Analytics data is required. Interface Analytics is optional. You can enable or disable it at the account or server level at any time. 

  • We take your privacy very seriously and have taken precautions to ensure that the data we collect is voluntary and secure. We retain cPanel Analytics data for 26 months and then destroy it.
  • For more information, read our cPanel Analytics documentation.

Configuration Analytics 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 the update log data that the system stored since your last update.

Additional documentation