Skip to content

Prerequisites for PMM Client

Before installing PMM Client, ensure your environment meets these requirements.

Quick requirements checklist

Hardware: 64-bit system (x86_64 or ARM64) with at least 100 MB storage
OS: Modern 64-bit Linux (Debian, Ubuntu, RHEL, Oracle Linux, Amazon Linux 2023)
Network: Connectivity to PMM Server (ports 80/443)
Software: curl, gnupg, sudo, wget
Database: Appropriate monitoring user credentials

System requirements

PMM Client is designed to be lightweight but requires:

  • Architecture: x86_64 or ARM64
  • RAM: Minimal (100-200 MB per monitored database instance)
  • Storage:
    • 100 MB for installation
    • VM Agent reserves 1 GB for caching during network outages

For comprehensive hardware specifications, see Hardware and system requirements.

Network connectivity

PMM Client requires these network connections:

Connection Port Purpose
PMM Client > PMM Server 443 (or 80) Metrics reporting and management
PMM Client > Database instances Varies by DB type Collection of monitoring data

For a complete list of ports and detailed network configuration options, see Network and firewall requirements.

Required software

  • Ensure these packages are installed before proceeding:

    curl gnupg sudo wget
    
  • For Docker-based deployment, you’ll also need Docker Engine properly installed and configured.

Database monitoring requirements

To monitor database instances, you’ll need:

  • Monitoring users: Database accounts with appropriate permissions
  • Log access: File system access to database logs where applicable
  • Performance schema: Enabled for MySQL monitoring (recommended)

Database monitoring requirements

To ensure successful database monitoring with PMM, confirm the following:

  • Monitoring users: Create database accounts with the required permissions
  • Log access: Enable file system access to database logs (where applicable)
  • Performance Schema: Recommended for enhanced MySQL monitoring

Before you install

Complete these steps before installing PMM Client:

  1. Install PMM Server using your preferred deployment method
  2. Note the PMM Server address (hostname or IP)
  3. Select your PMM Client deployment approach based on your environment needs
  4. Prepare database credentials for monitoring users
  5. Verify firewall rules allow necessary connections

Next steps

After confirming your environment meets these prerequisites:

  1. Install PMM Client using your preferred method
  2. Register the Client node with your PMM Server
  3. Add database instances for monitoring

Troubleshooting

If you encounter issues during installation or setup, refer to the Troubleshooting checklist.