Install PMM Client manually using binaries¶
This method allows you to install PMM Client using pre-compiled binary packages on a wide range of Linux distributions, for both x86_64 and ARM64 architectures.
Installing from binaries offers these advantages:
- supports Linux distributions not covered by package managers
- doesn’t require package managers
- allows installation without root permissions (unique to this method)
- provides complete control over the installation location
Tip for quick installation
For a quick installation:
- Download the PMM Client tar.gz file
- Extract it
- Run
./install_tarball
(or with-u
flag to preserve existing config during upgrades)
Prerequisites¶
Complete these essential steps before installation:
-
Check system requirements to ensure your environment meets the minimum criteria.
-
Install and configure PMM Server as you’ll its IP address or hostname to configure the Client.
-
Set up firewall rules to allow communication between PMM Client and PMM Server.
-
Create database monitoring users with appropriate permissions for the databases you plan to monitor.
-
Check that you have root or sudo privileges to install PMM Client. Alternatively, use binary installation for non-root environments.
Version information
The commands below are for the latest PMM release. If you want to install a different release, make sure to update the commands with your required version number.
Choose your installation path¶
Select the appropriate instructions based on your access level:
To install with root/administrator privileges:
-
Download the PMM Client package for your architecture:
wget https://downloads.percona.com/downloads/pmm3/3.3.0/binary/tarball/pmm-client-3.3.0-x86_64.tar.gz
wget https://downloads.percona.com/downloads/pmm3/3.3.0/binary/tarball/pmm-client-3.3.0-aarch64.tar.gz
-
Download the corresponding checksum file to verify integrity:
wget https://downloads.percona.com/downloads/pmm3/3.3.0/binary/tarball/pmm-client-3.3.0-x86_64.tar.gz.sha256sum
wget https://downloads.percona.com/downloads/pmm3/3.3.0/binary/tarball/pmm-client-3.3.0-aarch64.tar.gz.sha256sum
-
Verify the download:
sha256sum -c pmm-client-3.3.0-x86_64.tar.gz.sha256sum
sha256sum -c pmm-client-3.3.0-aarch64.tar.gz.sha256sum
-
Unpack the package and move into the directory:
tar xfz pmm-client-3.3.0-x86_64.tar.gz && cd pmm-client-3.3.0
tar xfz pmm-client-3.3.0-aarch64.tar.gz && cd pmm-client-3.3.0
-
Set the installation directory:
export PMM_DIR=/usr/local/percona/pmm
-
Run the installer:
sudo ./install_tarball
-
Update your PATH:
PATH=$PATH:$PMM_DIR/bin
-
Create symbolic links to make PMM commands available system-wide:
sudo ln -s /usr/local/percona/pmm/bin/pmm-agent /usr/local/bin/pmm-agent sudo ln -s /usr/local/percona/pmm/bin/pmm-admin /usr/local/bin/pmm-admin
-
Set up the agent:
sudo pmm-agent setup --config-file=/usr/local/percona/pmm/config/pmm-agent.yaml --server-address=192.168.1.123 --server-insecure-tls --server-username=admin --server-password=admin
-
Run the agent:
sudo pmm-agent --config-file=${PMM_DIR}/config/pmm-agent.yaml
-
Register your nodes to be monitored by PMM Server using the PMM Client:
sudo pmm-admin config --server-insecure-tls --server-url=https://admin:[email protected]:443
where:
X.X.X.X
is the address of your PMM Server443
is the default port numberadmin
/admin
is the default PMM username and password. This is the same account you use to log into the PMM user interface, which you had the option to change when first logging in.
HTTPS connection required
Nodes must be registered with the PMM Server using a secure HTTPS connection. If you try to use HTTP in your server URL, PMM will automatically attempt to establish an HTTPS connection on port 443. If a TLS connection cannot be established, you will receive an error message and must explicitly use HTTPS with the appropriate secure port.
Registration example
Register a node with IP address 192.168.33.23, type generic, and name mynode on a PMM Server with IP address 192.168.33.14:
sudo pmm-admin config --server-insecure-tls --server-url=https://admin:[email protected]:443 192.168.33.23 generic mynode
-
Verify the installation in a new terminal:
sudo pmm-admin status
Follow these steps for environments where you don’t have root access:
-
Download the PMM Client package for your architecture:
wget https://downloads.percona.com/downloads/pmm3/3.3.0/binary/tarball/pmm-client-3.3.0-x86_64.tar.gz
wget https://downloads.percona.com/downloads/pmm3/3.3.0/binary/tarball/pmm-client-3.3.0-aarch64.tar.gz
-
Download the corresponding checksum file to verify integrity:
wget https://downloads.percona.com/downloads/pmm3/3.3.0/binary/tarball/pmm-client-3.3.0-x86_64.tar.gz.sha256sum
wget https://downloads.percona.com/downloads/pmm3/3.3.0/binary/tarball/pmm-client-3.3.0-aarch64.tar.gz.sha256sum
-
Verify the download:
sha256sum -c pmm-client-3.3.0-x86_64.tar.gz.sha256sum
sha256sum -c pmm-client-3.3.0-aarch64.tar.gz.sha256sum
-
Unpack the package and move into the directory:
tar xfz pmm-client-3.3.0-x86_64.tar.gz && cd pmm-client-3.3.0
tar xfz pmm-client-3.3.0-aarch64.tar.gz && cd pmm-client-3.3.0
-
Set the installation directory:
export PMM_DIR=YOURPATH
Replace YOURPATH with a path where you have required access.
-
Run the installer:
./install_tarball
-
Update your PATH:
PATH=$PATH:$PMM_DIR/bin
-
Set up the agent:
pmm-agent setup --config-file=${PMM_DIR}/config/pmm-agent.yaml --server-address=192.168.1.123 --server-insecure-tls --server-username=admin --server-password=admin --paths-tempdir=${PMM_DIR}/tmp --paths-base=${PMM_DIR}
-
Run the agent:
pmm-agent --config-file=${PMM_DIR}/config/pmm-agent.yaml
-
Register your nodes to be monitored by PMM Server using the PMM Client:
pmm-admin config --server-insecure-tls --server-url=https://admin:[email protected]:443
where:
X.X.X.X
is the address of your PMM Server443
is the default port numberadmin
/admin
is the default PMM username and password. This is the same account you use to log into the PMM user interface, which you had the option to change when first logging in.
HTTPS connection required
Nodes must be registered with the PMM Server using a secure HTTPS connection. If you try to use HTTP in your server URL, PMM will automatically attempt to establish an HTTPS connection on port 443. If a TLS connection cannot be established, you will receive an error message and must explicitly use HTTPS with the appropriate secure port.
Registration example
Register a node with IP address 192.168.33.23, type generic, and name mynode on a PMM Server with IP address 192.168.33.14:
pmm-admin config --server-insecure-tls --server-url=https://admin:[email protected]:443 192.168.33.23 generic mynode
-
Open a new terminal and verify the installation:
pmm-admin status