PERCONA MONITORING AND MANAGEMENT DOCUMENTATION

Percona Monitoring and Management

Initializing search

Percona Monitoring and Management

Home
Get help from Percona
Discover
Discover
- Why PMM?
- Key features
Quickstart guide
Install
Install
- About PMM installation
- Plan your PMM installation
  Plan your PMM installation
  - Hardware and system requirements
  - Network and firewall requirements
- Install PMM Server
  Install PMM Server
  - About PMM Server installation
  - Prerequisites
  - Deployment options
    Deployment options
    
    Install on Docker
    Install on Docker
    
    Install PMM Server with Docker container
    
    Run Docker via the Easy-install script
    
    Setup and configuration
    Setup and configuration
    
    Run Docker with volume
    
    Run Docker with the host directory
    
    Environment variables in PMM
    
    Preview environment variables
    
    Isolated hosts
    
    Maintenance
    Maintenance
    
    Backup container
    
    Restore Docker container
    
    Remove container
    
    Upgrade container
    
    Install on Podman
    Install on Podman
    
    Install PMM Server with Podman on Docker image
    
    Maintenance
    Maintenance
    
    Backup podman container
    
    Restore podman container
    
    Remove podman container
    
    Install on Virtual Appliance
    Install on Virtual Appliance
    
    Install PMM Server on the virtual machine
    
    Setup
    Setup
    
    Download and verify OVA file
    
    VMware - Import OVA file
    
    VirtualBox - Import OVA file
    
    Log into user interface
    
    Maintenance
    Maintenance
    
    Remove virtual machine from UI
    
    Install on Helm
    Install on Helm
    
    Install PMM Server with Helm on Kubernetes clusters
    
    Maintenance
    Maintenance
    
    Back up Helm charts
    
    Restore Helm chart
    
    Install on AWS Marketplace
    Install on AWS Marketplace
    
    Install PMM Server from AWS Marketplace
    
    Setup and configuration
    Setup and configuration
    
    Limit Access to an AWS instance
    
    Applying settings
    
    Launch PMM Server on AWS
    
    Maintenance
    Maintenance
    
    Backup PMM Server
    
    Restore PMM Server from a backup
    
    Remove PMM Server from AWS
- Install PMM Client
  Install PMM Client
  - About PMM Client installation
  - Prerequisites for PMM Client
  - Deployment options
    Deployment options
    
    Install from Percona repositories
    
    Install on Docker
    
    Install from binaries
  - Configuration
    Configuration
    
    Register Client node
    
    Configure monitoring
    Configure monitoring
    
    About connecting services for monitoring
    
    Databases
    Databases
    
    MySQL
    
    MongoDB
    
    PostgreSQL
    
    Cloud services
    Cloud services
    
    AWS
    
    Azure
    
    Google Cloud
    
    System monitoring
    System monitoring
    
    Linux
    
    Remote
    
    Proxy services
    Proxy services
    
    HAproxy
    
    ProxySQL
    
    External services
    External services
    
    Connect external instance
    
    Maintenance
    Maintenance
    
    Remove services
Upgrade
Upgrade
- Upgrade PMM Server
  Upgrade PMM Server
  - About PMM Server upgrade
  - Upgrade PMM v3 Server from the UI
  - 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
  - Upgrade PMM Server on AWS
- Upgrade PMM Client
  Upgrade PMM Client
  - Upgrade PMM Client
Uninstall
Uninstall
- Uninstall PMM Client
  Uninstall PMM Client
- Unregister PMM Client from PMM Server
Use
Use
- About using PMM
- PMM user interface
  PMM user interface
- PMM Inventory
- Metrics monitoring
  Metrics monitoring
  - About monitoring in PMM
  - PMM metrics
    PMM metrics
    
    About PMM metrics
    
    Extend metrics
  - Optimize
    Optimize
    
    Improve PMM performance
    
    Disable per-table statistics
    
    Change the number of tables
  - 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
- Backup and restore
  Backup 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
- PMM commands
  PMM commands
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 access control in PMM
    
    Labels for access control
    
    Configure access control
    
    Create access roles
    
    Manage access roles
    
    Assign roles to users
    
    Use Case
Troubleshoot
Troubleshoot
Release notes
Release notes
Reference
Reference
- Architecture
  Architecture
  - PMM Architecture
  - Third-party components in PMM
    Third-party components in PMM
    
    VictoriaMetrics
    
    ClickHouse
    
    PostgreSQL
  - PMM components and versions
  - Data handling in PMM
  - PMM API
    PMM API
    
    About PMM API
    
    Service accounts authentication
- 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
  - PostgreSQL dashboards
    PostgreSQL dashboards
    
    PostgreSQL Instances Overview
    
    PostgreSQL Instance Summary
    
    PostgreSQL Instances Compare
    
    Experimental PostgreSQL Vacuum Monitoring
  - 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
- 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

Page not found

Percona LLC and its affiliates © 2025 — Cookie Preferences

Made with Material for MkDocs