PERCONA MONITORING AND MANAGEMENT DOCUMENTATION

Percona Monitoring and Management

Index

Initializing search

percona/pmm

Percona Monitoring and Management

percona/pmm

Home
Get help from Percona
Discover
Discover
- Why PMM?
- Key features
Quickstart guide
Install
Install
- PMM installation overview
- Plan your PMM installation
  Plan your PMM installation
- Install PMM Server
  Install PMM Server
  - Server installation overview
  - Prerequisites
  - Deployment options
    Deployment options
    
    Install on Docker
    Install on Docker
    
    Install PMM Server with Docker
    
    Run Docker via the Easy-install script
    
    Storage setup
    Storage setup
    
    Docker volumes (recommended)
    
    Host directory (not recommended)
    
    Setup and configuration
    Setup and configuration
    
    Environment variables
    
    Preview environment variables
    
    Install PMM Server in isolated environments
    
    Container settings
    Container settings
    
    Back up PMM Server Docker container
    
    Restore PMM Server Docker container
    
    Remove PMM Server Docker container
    
    Upgrade PMM Server Docker container
    
    Install on Podman
    Install on Podman
    
    Install PMM Server with Podman
    
    Setup and configuration
    Setup and configuration
    
    Back up PMM Server Podman container
    
    Restore PMM Server Podman container
    
    Remove PMM Server Podman container
    
    Install on Virtual Appliance
    Install on Virtual Appliance
    
    Deploy PMM Server as a Virtual Appliance (OVA)
    
    Setup and configuration
    Setup and configuration
    
    Download and verify OVA file
    
    Deploy PMM Server on VMware
    
    Deploy PMM Server on VirtualBox
    
    Access the PMM Server Virtual Appliance web interface
    
    Remove PMM Server Virtual Appliance
    
    Install on Kubernetes
    Install on Kubernetes
    
    Install PMM Server with Helm on Kubernetes clusters
    
    Backup & maintenance
    Backup & maintenance
    
    Back up PMM Server Helm deployment
    
    Restore Helm chart
    
    Install on AWS Marketplace
    Install on AWS Marketplace
    
    Plan PMM Server deployment from AWS
    
    Deploy PMM Server on AWS
    
    Configure PMM Server on AWS
- Install PMM Client
  Install PMM Client
  - Client installation overview
  - Prerequisites for PMM Client
  - Deployment options
    Deployment options
    
    Install with Package Manager
    
    Install from binaries
    
    Install on Docker
  - Configure monitoring
    Configure monitoring
    
    Database monitoring
    Database monitoring
    
    Overview
    
    MySQL
    
    MongoDB
    
    PostgreSQL
    
    Cloud services monitoring
    Cloud services monitoring
    
    AWS
    
    Azure
    
    Google Cloud
    
    System monitoring
    System monitoring
    
    Linux
    
    Remote
    
    Proxy services monitoring
    Proxy services monitoring
    
    HAproxy
    
    ProxySQL
    
    External services monitoring
    External services monitoring
    
    Connect external instance
- Install PMM in HA mode
Use
Use
- About using PMM
- PMM user interface
  PMM user interface
- PMM Inventory
- Remove services
- Metrics monitoring
  Metrics monitoring
  - About monitoring in PMM
  - PMM metrics
    PMM metrics
    
    About PMM metrics
    
    Extend metrics
  - Dashboards
    Dashboards
    
    Dashboards overview
    
    Manage dashboards
    Manage dashboards
    
    Create dashboard folders
    
    Manage dashboard folders
    
    Setting custom Home dashboard
    
    Share dashboards and panels
    
    Annotate
- Query Analytics
  Query Analytics
  - About Query Analytics (QAN)
  - Query Analytics for MongoDB
  - Share a link for Query Analytics
  - Panels on QAN dashboard
    Panels on QAN dashboard
    
    Overview Panel
    
    QAN Filters panel
    
    Details panel
- Advisors
  Advisors
- Percona Alerting
  Percona Alerting
- Back up and restore
  Back up and restore
  - Back up and restore
  - Prepare a storage location
  - MongoDB backups
    MongoDB backups
    
    Supported setups for MongoDB backups
    
    MongoDB backup prerequisites
    
    Create MongoDB on-demand and scheduled backups
    
    Create MongoDB PITR backups
    
    Restore a MongoDB backup
    
    MongoDB Backup and Restore support matrix
  - MySQL backups
    MySQL backups
    
    MySQL backup prerequisites
    
    Supported setups for MySQL backups
    
    Create a MySQL backup
    
    Restore a MySQL backup
  - Edit a scheduled backup
  - Delete a backup
Configure
Configure
- Configure PMM
- Metrics resolution
- Advanced PMM settings
- SSH Key
- Security in PMM
  Security in PMM
- Percona Platform
  Percona Platform
Administer
Administer
- About PMM administration
- Manage users
  Manage users
- Roles and permissions
  Roles and permissions
  - Standard role permissions
  - Label-based access control
    Label-based access control
    
    About label based access control (LBAC) in PMM
    
    Labels for access control
    
    Enable access control
    
    Create access roles
    
    Manage access roles
    
    Assign access roles to users
    
    Implementing LBAC: practical scenarios
Upgrade
Upgrade
- Upgrade PMM Server
  Upgrade PMM Server
  - About PMM Server upgrade
  - Upgrade PMM v3 Server from the UI
  - Migrate external PostgreSQL configuration for PMM 3.2.0+ upgrades
  - Manual upgrade
    Manual upgrade
    
    Manual upgrade: Upgrade PMM Server using Docker
    
    Manual upgrade: Upgrade PMM Server using Podman
  - Upgrade PMM Server in K8s
    Upgrade PMM Server in K8s
    
    Upgrade PMM Server using Helm
  - Migrate PMM 2 to PMM 3
  - Migrate from VMware to alternative platforms
  - Upgrade PMM Server on AWS
- Upgrade PMM Client
Uninstall
Uninstall
- About uninstalling PMM
- Unregister PMM Client from PMM Server
- Uninstall PMM Client
  Uninstall PMM Client
Troubleshoot
Troubleshoot
Release notes
Release notes
Reference
Reference
- Architecture
  Architecture
  - PMM Architecture
  - Third-party components in PMM
    Third-party components in PMM
    
    VictoriaMetrics
    
    Use external ClickHouse with PMM
    
    Configure PMM with external PostgreSQL
  - PMM components and versions
  - Data handling in PMM
  - PMM API
    PMM API
    
    About PMM API
    
    Service accounts authentication
  - PMM commands
    PMM commands
    
    About PMM commands
    
    pmm-admin - PMM administration tool
    
    pmm-agent - PMM Client agent
- PMM dashboards
  PMM dashboards
  - Insight
    Insight
    
    Home Dashboard
    
    Advanced Data Exploration
    
    VictoriaMetrics
    
    VictoriaMetrics Agents Overview
  - Environments
    Environments
    
    Environment Overview
    
    Environment Summary
  - Kubernetes
    Kubernetes
    
    Kubernetes Cluster Summary
    
    Kubernetes monitoring for Percona Operators
    
    DB clusters managed with Percona Kubernetes Operators
  - OS Dashboards
    OS Dashboards
    
    CPU Utilization Details
    
    Disk Details
    
    Network Details
    
    Memory Details
    
    Node Temperature Details
    
    Nodes Compare
    
    Nodes Overview
    
    Node Summary
    
    NUMA Details
    
    Processes Details
  - Prometheus dashboards
    Prometheus dashboards
    
    Prometheus Exporter Status
    
    Prometheus Exporters Overview
  - MySQL dashboards
    MySQL dashboards
    
    MySQL Amazon Aurora Details
    
    MySQL Command/Handler Counters Compare
    
    MySQL InnoDB Compression Details
    
    MySQL InnoDB Details
    
    MySQL MyISAM/Aria Details
    
    MySQL MyRocks Details
    
    MySQL Instance Summary
    
    MySQL Instances Compare
    
    MySQL Instances Overview
    
    MySQL Wait Event Analyses Details
    
    MySQL Performance Schema Details
    
    MySQL Query Response Time Details
    
    MySQL Replication Summary
    
    MySQL Group Replication Summary
    
    MySQL Table Details
    
    MySQL User Details
    
    MySQL TokuDB Details
  - MongoDB dashboards
    MongoDB dashboards
    
    Experimental MongoDB Collection Overview
    
    Experimental MongoDB Collection Details
    
    Experimental MongoDB Oplog Details
    
    MongoDB Sharded Cluster Summary
    
    MongoDB Instance Summary
    
    MongoDB Instances Overview
    
    MongoDB Instances Compare
    
    MongoDB ReplSet Summary
    
    MongoDB Router Summary
    
    MongoDB InMemory Details
    
    MongoDB MMAPv1 Details
    
    MongoDB WiredTiger Details
    
    MongoDB PBM Details dashboard
  - PostgreSQL dashboards
    PostgreSQL dashboards
    
    PostgreSQL Checkpoints, Buffers and WAL Usage
    
    PostgreSQL Instance Summary
    
    PostgreSQL Instances Compare
    
    PostgreSQL Instances Overview
    
    PostgreSQL Instances Overview Extended
    
    PostgreSQL Patroni Details
    
    PostgreSQL Replication Overview
    
    PostgreSQL Top Queries
  - ProxySQL dashboards
    ProxySQL dashboards
    
    ProxySQL Instance Summary
  - HA dashboards
    HA dashboards
    
    PXC/Galera Node Summary
    
    PXC/Galera Cluster Summary
    
    Experimental PXC/Galera Cluster Summary
    
    PXC/Galera Nodes Compare
    
    HAProxy Instance Summary
- Configure Nomad
- Glossary
- FAQ
- Trademark policy
- Copyright and licensing information

Download PDF

For help, click the link below to get free database assistance or contact our experts for personalized support.

Get help from Percona

Index

2025-07-14

Was this page helpful?

Thank you for your feedback!

Thanks for your feedback! Want to improve this page? Click the Improve this page button above to submit a pull request!

Made with Material for MkDocs