cPanel Plugin Setup

What is the cPanel Plugin?

The Server Scout cPanel plugin provides comprehensive monitoring for servers running the cPanel/WHM hosting control panel. This plugin automatically collects detailed hosting metrics, giving you valuable insights into your hosting environment without the need for manual data gathering.

Monitored Metrics

The cPanel plugin tracks essential hosting metrics that are crucial for capacity planning and hosting management:

Account Management:

• Total number of cPanel accounts
• Number of suspended accounts
• Account status changes over time

Resource Usage:

• Disk usage per individual cPanel account
• Overall disk space utilisation across all accounts
• Storage trends and growth patterns

Service Metrics:

• Number of addon domains per account
• Total email accounts across all hosting packages
• Database count (MySQL/PostgreSQL) per account

These metrics help you identify resource bottlenecks, monitor growth trends, and ensure optimal server performance for your hosting customers.

Enabling the cPanel Plugin

The cPanel plugin is designed for simplicity—it automatically detects when cPanel is installed on your server and begins collecting data without manual intervention.

Automatic Detection

1. Install Server Scout on your cPanel server using the standard installation process
2. Allow detection time—the plugin typically detects cPanel within 5-10 minutes of the first monitoring cycle
3. Verify detection by checking the server detail page for the Plugins section

Manual Verification

If you need to verify that cPanel is properly detected, you can check the monitoring agent status:

sudo systemctl status scout-agent

The agent logs will show cPanel detection:

sudo journalctl -u scout-agent | grep -i cpanel

Troubleshooting Detection

If the plugin doesn't automatically detect cPanel, ensure:

• cPanel/WHM is properly installed and running
• The Server Scout agent has sufficient permissions to read cPanel configuration files
• No firewall rules are blocking the monitoring agent

Viewing cPanel Data

Once enabled, cPanel metrics appear in your Server Scout dashboard under the Plugins section of your server detail page.

Dashboard Layout

The cPanel plugin data is organised into clear, actionable sections:

Account Overview:

• Current active accounts vs. total capacity
• Suspended account alerts
• Recent account changes

Resource Utilisation:

• Per-account disk usage charts
• Top disk consumers
• Storage growth trends over time

Service Distribution:

• Email accounts per hosting package
• Database usage patterns
• Domain distribution across accounts

Accessing Historical Data

Click on any metric to view historical trends, helping you identify:

• Seasonal usage patterns
• Rapid growth accounts requiring attention
• Overall server capacity trends

Using cPanel Data for Management

Capacity Planning

Monitor disk usage trends to:

• Predict storage needs before running out of space
• Identify growth patterns in your hosting customer base
• Plan hardware upgrades based on actual usage data

Example: If you notice consistent 10% monthly growth in disk usage, you can proactively plan storage expansion.

Customer Management

Track account metrics to:

• Identify resource-heavy customers who might need plan upgrades
• Monitor suspended accounts for billing or policy issues
• Analyse email and database usage for service optimisation

Performance Optimisation

Use the collected data to:

• Balance account distribution across multiple servers
• Identify accounts causing performance issues
• Optimise resource allocation based on actual usage patterns

Proactive Monitoring

Set up alerts based on cPanel metrics:

• High disk usage per account (approaching package limits)
• Unusual spikes in database or email account creation
• Significant changes in suspended account numbers

Best Practices

Regular Review: Check your cPanel metrics weekly to stay ahead of capacity issues.

Trend Analysis: Use historical data to make informed decisions about hosting packages and server resources.

Alert Configuration: Set meaningful thresholds that allow time for proactive management without creating alert fatigue.

The cPanel plugin transforms raw hosting data into actionable insights, making server management more efficient and helping you provide better service to your hosting customers.