pmm-admin command overview¶

pmm-admin is the command-line tool for managing your PMM monitoring setup. Use it to add databases, check connection status, update agent configurations, and troubleshoot issues from your terminal.

pmm-admin is installed automatically with PMM Client.

To add services through the UI instead, see Connect databases via the web interface. For programmatic access, see the PMM API.

Use pmm-admin to:

add MySQL, PostgreSQL, MongoDB, Valkey, ProxySQL, and HAProxy services to monitoring
check connection status between PMM Client and PMM Server
list monitored services and their agents
modify agent configurations without removing services
create diagnostic archives for troubleshooting

Syntax¶

Run pmm-admin commands in this format:

pmm-admin COMMAND [COMMAND-FLAGS] [ARGUMENTS] [FLAGS]

Quick start¶

Try these common commands to verify your setup and start monitoring:

Check PMM Client status¶

pmm-admin status

Add a MySQL database¶

pmm-admin add mysql mysql-prod 192.168.1.10:3306 --username=pmm --password=pass

Add a MongoDB database¶

pmm-admin add mongodb mongodb-prod 192.168.1.20:27017 --username=pmm --password=pass

List monitored services¶

pmm-admin list

Create diagnostic archive¶

pmm-admin summary

For complete options and flags, see Add database services, Manage inventory, Configuration commands, and Status and diagnostics.

Command reference¶

Find all available commands for managing monitored services:

Command	Description	Documentation
`pmm-admin add`	Add database services to monitoring	Add database services
`pmm-admin inventory`	List and modify agents and services	Manage inventory
`pmm-admin config`	Configure local pmm-agent	Configuration commands
`pmm-admin register`	Register node with PMM Server	Configuration commands
`pmm-admin remove`	Remove service from monitoring	Configuration commands
`pmm-admin annotate`	Add event annotations	Configuration commands
`pmm-admin status`	Show PMM Client status	Status and diagnostics
`pmm-admin list`	List monitored services	Status and diagnostics
`pmm-admin summary`	Create diagnostic archive	Status and diagnostics

Add and remove services¶

pmm-admin add: Add database services to monitoring
pmm-admin remove: Remove service from monitoring

Manage inventory¶

pmm-admin inventory: List and modify agents and services

Configure and register¶

pmm-admin config: Configure local pmm-agent
pmm-admin register: Register node with PMM Server
pmm-admin annotate: Add event annotations

Status and troubleshooting¶

pmm-admin status: Show PMM Client status
pmm-admin list: List monitored services
pmm-admin summary: Create diagnostic archive

Get help¶

Run --help with any command to see available flags and usage:

pmm-admin COMMAND --help

For example:

pmm-admin add mysql --help
pmm-admin inventory change agent --help