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

The optional cPanel Analytics features collect data about interface use and server configuration. The data that we gather may change in the future.

Important:

cPanel Analytics features are optional. You can enable or disable them 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.

Interface Analytics

When you enable Interface Analytics at the server level and users enable it at the account level, the plugin gathers the following data:

  • The server's cPanel & WHM product version.
  • The operating system (OS) and OS version.
  • Whether an account is a cPanel, WHM, or Webmail account.
  • The company ID as it exists in Manage2's Update Company Information interface ( Manage2 >> Company >> Update Company Information ) or in the /var/cpanel/companyid file.

    Note:

    Interface Analytics gathers the company ID as part of our partnership with individual customers. Our Account Management, Customer Service, and Marketing teams may analyze this data. For more information, contact our Account Management team.


  • cPanel or Webmail accounts' interface style and theme.
  • The frequency with which cPanel, WHM, and Webmail users access their accounts and the type of devices that they use.
  • The use of specific features and cPanel-provided locales.

Configuration Analytics

When you enable Configuration Analytics, the system can gather data about your server's configuration, updates, and use. Some of these values come from the cpanel.config file or WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings). Other data comes from feature-specific sources or internal system values.

Configuration Analytics gathers use information for all of cPanel & WHM's default Access Control Lists (ACLs).

For more information, read our Guide to WHM Plugins - ACL Reference Chart documentation.

Configuration Analytics gathers the following data about Guide to cPanel API 1 use:

DataWhat we gather
api1_callsThe number of calls to cPanel API 1 functions.
api1_pages The number of interfaces on the server that include cPanel API 1 functions.

Note:

We started collecting cPanel API 1 use data in cPanel & WHM version 80.


Configuration Analytics gathers the following  API Tokens data:

DataWhat we gather
number_of_users_with_tokens The number of accounts that currently use the API Tokens feature.

Configuration Analytics gathers the entire contents of the cpanel.config file.

Note:

For a full list of settings and the interfaces to set them, read our The cpanel.config File documentation.

Configuration Analytics gathers the following data from the cpsources.conf file:

DataWhat we gather
MYIPThe URL that determines this server's public-facing IP address.
NEWSThe archaic address that the system uses to retrieve news to display in WHM.

Configuration Analytics gathers the following data from the sysinfo.config file:

Data

What we gather

rpm_dist

The name of the server's Linux distribution.

ises

Whether the server uses Red Hat® Enterprise Linux®.

lock

The sysinfo_config values that cPanel & WHM doesn't change.

rpm_dist_ver

The Linux distribution's version.

rpm_arch

The machine architecture.

releaseThe Linux distribution's release number.

Configuration Analytics gathers the following data about each cPAddon on your server:

  • The cPAddon's name. 

    Note:

    The system retrieves this from the description return in UAPI's  cPAddons::get_available_addons function.

  • The number of installations on the server.
  • The number of up-to-date installations on the server.
  • Whether customers on the server can currently install the cPAddon.

Configuration Analytics gathers the following data about MySQL® on your server:

Data

What we gather

old_passwords

Whether MySQL allows old-style passwords.

userstat
Whether MySQL collects user statistics.
users_with_old_passwords
The number of users with old-style passwords.

Configuration Analytics gathers the following data about remote MySQL and MariaDB databases:

Data

What we gather

is_local

Whether the MySQL server is on the local server.

addressThe address and port for the MySQL server.
setup_with_sshWhether the MySQL server setup process used SSH.

Additionally, Configuration Analytics gathers the following data about PostgreSQL on your server:

Data

What we gather

installed

Whether PostgreSQL exists on the server.

In cPanel & WHM version 78 and earlier, Configuration Analytics gathered information about your server's use of EasyApache 3 and its modules. 

Configuration Analytics gathers the following data about EasyApache 4:

DataWhat we gather
easyapache_version The version of EasyApache (EA) that your customers use.

Configuration Analytics gathers the following data about third-party MX records:

Data

What we gather

mx_type : number_of_gapps

The number of domains that use G Suite by Google Cloud for email.

mx_type : number_of_o365

The number of domains that use Microsoft's Office 365 for email.

Configuration Analytics gathers the following data about your server's use of Greylisting:

Data

What we gather

is_enabled

Whether the Greylisting feature is enabled server-wide.

trusted_hosts

The list of trusted domains for the server.

total_number_of_domains_on_server

The number of domains on the server.

possible_spam_count

The number of emails that the Greylisting feature has marked as spam.

triplets_deferred_count

The number of emails that the Greylisting feature has deferred.

number_of_domains_opted_out

The number of domains that have opted out of the Greylisting feature.

Configuration Analytics gathers the following data about your installation of cPanel & WHM:

Data

What we gather

cpanel_install_mtime

The date and time at which you initially installed cPanel & WHM.

dnsonly

Whether you're using cPanel DNSONLY.

ea_libcurl_version

The version of libcurl on your server.

easyapache_version

The version of EasyApache (EA) that your customers use.

envtype

Your cPanel & WHM installation's environment type.

mem_swap

The amount of memory swap space on the server.

mem_total

The amount of memory on the server.

server_mainipv4

The server's primary IPv4 address.

server_install_uuid

The installation's unique identifier.
before The cPanel & WHM version before the update.
after The cPanel & WHM version after the update.

Configuration Analytics gathers the following data about your server's use of IPv6:

Data

What we gather

bound_address_count

The number of IPv6 addresses on the server.

all_accounts

The number of accounts on the server.

accounts_with_jailshell

The number of accounts that use jailshell.

num_a6_records

The number of deprecated A6 records.

has_slaac

Whether the server uses a SLAAC IPv6 address.

has_ipv6_address_range

Whether the server uses an IPv6 range.

host_is_slaac

Whether the host uses a SLAAC IPv6 address.

accounts_with_ipv6

The number of accounts that use IPv6 addresses.

network_interfaces

The network devices that the system uses.

Configuration Analytics gathers a list of custom locales on your server via the number_of_users_with_tokens value.

Note:

Custom locales are locales that cPanel, L.L.C. doesn't distribute.

Configuration Analytics gathers the following data about each account's locale:

Data

What we gather

custom_locale

The locales that are available on the server.

locale

The names of accounts that use a specific language.

Configuration Analytics gathers the following data about your nameservers:

Data

What we gather

clustering

Whether you configured the DNS server for clustering.

secure_zone_count
The number of zones that use DNSSEC records.
type
The type of DNS server configuration.
zone_count
The number of configured zones.

Configuration Analytics gathers the following data about the rpm.versions system's RPMs.

Data

What we gather

rpm_locations

The location of RPMs that third parties modify.

url_templatesThe URL of the template that the rpm.versions system consumes.
srpm_versionsThe version of the source RPMs that the rpm.versions system consumes.
file_format.versionThe file format version for the rpm.versions system.
target_settings.softwareWhether the rpm.versions-defined RPMs installed successfully.
install_targetsThe installation target for the RPMs.

Configuration Analytics gathers the following data about Ruby Passenger:

Data

What we gather

number_of_ruby_apps

The number of installed Ruby applications.

has_modpassengerWhether Phusion Passenger is installed.

Configuration Analytics gathers the following data about use rates for the Site Publisher feature:

Data

What we gather

total

The total number of Site Publisher websites on the server.

system

The number of domains that are using root-provided templates.

cpanel

The number of domains that are using cPanel-provided templates.

reseller

The number of domains that are using reseller-provided templates.

domains The number of domains that host a Site Publisher website.

Configuration Analytics gathers the following data about the cPanel interface's theme:

Data

What we gather

system_branding

The number of accounts that use branded themes.

paper_lantern

The number of accounts that use cPanel’s Paper Lantern theme.

default_theme

The default theme for new accounts.

reseller_branding

The number of reseller-owned accounts that use branded themes.

X3

The number of accounts that use the legacy x3 theme.

X3mail

The number of accounts that use the legacy x3mail theme.

retro_users

The number of accounts that use the Retro style.

Note:

We started collecting this data in cPanel & WHM version 80.

Configuration Analytics gathers the following data about Two-Factor Authentication (2FA):

Data

What we gather

is_root_configured

Whether the root user uses 2FA.
is_enabled_on_serverWhether 2FA is enabled.
total_accounts_with_tfa_configuredThe number of accounts that use 2FA.

Configuration Analytics gathers the following data about cPanel & WHM updates:

Data

What we gather

duration

The duration of your most-recent cPanel & WHM update.

result

Whether the most-recent cPanel & WHM update was successful.

update_blockers

Any blockers that prevented cPanel & WHM from updating.

used_ea_tarball

Whether the update used the EA tarball.

used_fast_install

Whether the server used the fast installation method.

Configuration Analytics gathers the following data from the cpsources.conf file:

DataWhat we gather
LAYERThe archaic mirrors that the system uses to install and update software.
RSYNC
HTTPUPDATEThe mirror that the system uses to install and update software.

Configuration Analytics gathers the following data from the cpupdate.conf file:

DataWhat we gather
RPMUPThe frequency of automatic RPM updates.
CPANELThe server's configured cPanel & WHM release tier.
UPDATESThe frequency of cPanel & WHM updates.
SARULESUPThe frequency of Apache SpamAssassin™ updates.
STAGING_DIRThe directory that the system uses to stage updates.

Additional documentation