Skip to content

Rate this page
Thanks for your feedback
Thank you! The feedback has been submitted.

Get free database assistance or contact our experts for personalized support.

Check connection status with pmm-admin

Check PMM Client connection status, list monitored services, and create diagnostic archives from the command line using these pmm-admin commands.

To view status in the UI, see PMM Inventory. For programmatic access, see the PMM API.

Commands

Command Use it to
pmm-admin status Check if PMM Client can connect to PMM Server
pmm-admin list Show all monitored services and their agents
pmm-admin summary Create a diagnostic archive for troubleshooting or support requests

pmm-admin status

Check the connection between PMM Client and PMM Server. Use this to verify PMM Client is properly configured and can communicate with the server.

Syntax

pmm-admin status [FLAGS]

Flags

Flag Description
--json Output in JSON format
--wait=<period><unit> Time to wait for a successful response from pmm-agent. Use an integer followed by a unit: ms (milliseconds), s (seconds), m (minutes), h (hours). Example: --wait=30s

Example output

Agent ID : abcd1234-5678-90ef-ghij-klmnopqrstuv
Node ID  : abcd1234-5678-90ef-ghij-klmnopqrstuv
Node name: db-server-01

PMM Server:
    URL    : https://192.168.1.100:443/
    Version: 3.0.0

PMM Client:
    Connected        : true
    Time drift       : -1.234ms
    Latency          : 5.678ms
    pmm-agent Version: 3.0.0
    pmm-agent Uptime : 48h30m15s

Interpret the output

Field What it means
Connected: true PMM Client is communicating with PMM Server
Connected: false Connection failed — check server URL and network
Time drift Clock difference between client and server (keep under 1 second)
Latency Network round-trip time to server

Wait for connection

Use the --wait flag to wait for the agent to become ready, for example in automated scripts or startup sequences:

pmm-admin status --wait=30s

Troubleshoot connection issues

Connection refused

pmm-admin status
# Error: ...connection refused

Check that PMM Server is running and the URL is correct:

pmm-admin config --server-url=https://username:[email protected]:443

Certificate errors

pmm-admin status
# Error: ...certificate signed by unknown authority

For self-signed certificates, use:

pmm-admin config --server-url=https://admin:[email protected]:443 --server-insecure-tls

High time drift

If time drift exceeds 1 second, synchronize clocks using NTP:

sudo systemctl start chronyd
# or
sudo ntpdate pool.ntp.org

pmm-admin list

Show all services and agents registered on this node, including the agent metrics mode (push/pull). Use this to verify which databases are being monitored and check agent status.

Syntax

pmm-admin list [FLAGS]

Flags

Flag Description
--json Output in JSON format

Example output

Service type        Service name        Address and port        Service ID
MySQL               mysql-prod          192.168.1.10:3306       abc123
MongoDB             mongodb-prod        192.168.1.20:27017      def456
PostgreSQL          postgres-prod       192.168.1.30:5432       ghi789

Agent type                  Status      Metrics Mode      Agent ID                              Service ID
pmm_agent                   Connected                     xyz789
node_exporter               Running     push              node123
mysqld_exporter             Running     push              mysql123                    abc123
mongodb_exporter            Running     push              mongo123                    def456
postgres_exporter           Running     push              pg123                       ghi789

Interpret agent status

Status What it means
Running Agent is collecting metrics normally
Waiting Agent is starting or waiting to connect
Stopping Agent is shutting down
Done Agent has stopped
Unknown Cannot determine agent status

Filter output with grep

Find MySQL services:

pmm-admin list | grep -i mysql

Find agents with issues:

pmm-admin list | grep -v Running

pmm-admin summary

Create a diagnostic archive containing logs, configuration, and status information. Use this when troubleshooting issues or submitting support requests to Percona.

The default archive filename is summary_<hostname>_<year>_<month>_<date>_<hour>_<minute>_<second>.zip, created in the current directory.

The archive includes:

  • PMM Client logs
  • Agent configuration files
  • Service status and inventory
  • System information (OS, hardware)
  • Network diagnostics

Syntax

pmm-admin summary [FLAGS]

Flags

Flag Description
--filename=PATH Output file path (default: auto-generated in current directory)
--skip-server Skip collecting PMM Server logs (logs.zip)
--pprof Include Go performance profiling data (for advanced debugging)
--json Output summary metadata in JSON format

Examples

Create a diagnostic archive:

pmm-admin summary

Output:

Created summary file: /home/user/summary_db-server-01_2024-01-15T10-30-00.zip

Save to a specific location:

pmm-admin summary --filename=/tmp/pmm-diagnostic.zip

Create archive without contacting PMM Server:

pmm-admin summary --skip-server

Include profiling data for performance issues:

pmm-admin summary --pprof

What’s in the archive

summary_db-server-01_2024-01-15T10-30-00/
├── client/
│   ├── pmm-agent.log
│   ├── pmm-agent.yaml
│   ├── status.json
│   └── list.txt
├── systeminfo/
│   ├── os-release
│   ├── uname.txt
│   └── df.txt
└── server/
    └── logs.zip (if --skip-server not used)

Submit to Percona Support

When opening a support ticket:

  1. Create the summary archive:

    pmm-admin summary
    
  2. Attach the .zip file to your support ticket.

  3. Include a description of the issue, steps to reproduce, and when it started.

See also