Valid for versions 82 through the latest version
Version:
82
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.
- Configuration Analytics is required. Interface Analytics is optional.
- You can enable or disable Interface Analytics at the account or server level at any time. We don’t collect any Interface Analytics data until the
rootuser 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.
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 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
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 for the current account, perform the following steps:
-
Click the graph icon (
) in the bottom right corner of the interface. -
Select the desired Interface Analytics setting:
- Select Allow Data Collection to enable data collection.
- Select Deny Data Collection to disable data collection.
Enable or disable Interface Analytics at the server level
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.
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, an icon will appear in the cPanel, WHM, and Webmail interfaces.
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 current account, perform the following steps:
-
Click the graph icon (
) in the bottom-right corner of the interface. -
Select the desired cPanel Analytics setting:
- Select Allow Data Collection to enable data collection.
- Select Deny Data Collection to disable data collection.
Configuration Analytics
In cPanel & WHM version 78 and later, Configuration Analytics participation is required. We have classed this data as operational data that cPanel, L.L.C. requires in order to make vital business decisions.
- When you upgrade to cPanel & WHM version 78 or higher, the system will automatically enable Configuration Analytics.
- This does not enable Interface Analytics or alter your participation (or choice not to participate) in that program.
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.
- The
gather-update-logsscript sends this data. - For more information, read our cPanel Analytics – The Data We Use documentation.
Enable or disable in cPanel & WHM versions 74 and 76
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).
