This is an Alpha version of Percona Monitoring and Management 3.0.0 and it is not recommended for production environments yet. We encourage you to test it and give your feedback. This will help us improve the product and make it production-ready faster.

Percona Documentation

View

Initializing search

percona/pmm-doc

Percona Monitoring and Management

percona/pmm-doc

Home
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 in HA mode
- Install PMM Server
  Install PMM Server
  - About PMM Server installation
  - Prerequisites
  - Bare metal
    Bare metal
    
    Docker
    Docker
    
    Easy install
    
    Install PMM Server with Docker container
    
    Run Docker with volume
    
    Run Docker with data container
    
    Run Docker with the host directory
    
    Backup container
    
    Restore container
    
    Remove container
    
    Environment variables in PMM
    
    Preview environment variables
    
    Isolated hosts
    
    Podman
    Podman
    
    Install PMM Server with Podman on Docker image
    
    Backup podman container
    
    Restore podman container
    
    Remove podman container
    
    Virtual Applinace
    Virtual Applinace
    
    Install PMM Server on the virtual machine
    
    Download and verify OVA file
    
    VMware - Import OVA file
    
    VirtualBox - Import OVA file
    
    Log into user interface
    
    Remove virtual machine from UI
  - Helm
    Helm
    
    Install PMM Server with Helm on the Kubernetes clusters
    
    Back up Helm charts
    
    Restore Helm chart
  - AWS Marketplace
    AWS Marketplace
    
    Install PMM Server on AWS Marketplace
    
    Limit Access to the instance
    
    Applying settings
    
    Run the instance
    
    Backup PMM Server
    
    Restore PMM Server from a backup
    
    Remove PMM Server
- Set up PMM Client
  Set up PMM Client
  - Install PMM Client
    Install PMM Client
    
    About PMM client installation
    
    Prerequisites
    
    Percona repositories
    
    Images
    
    Manual binaries
    
    Register Client node
    
    Add services to PMM
    Add services to PMM
    
    About connecting services for monitoring
    
    MySQL
    
    MongoDB
    
    PostgreSQL
    
    AWS
    
    Azure
    
    Google Cloud
    
    Linux
    
    Remote
    
    External
    External
    
    Connect an external instance
    
    HAproxy
    
    ProxySQL
    
    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
    
    Upgrade PMM Server using Docker
    
    Upgrade PMM Server using Podman
  - Upgrade PMM Server in K8s
    Upgrade PMM Server in K8s
    
    Upgrade PMM Server using Helm
  - Upgrade PMM Client
  - Upgrade from PMM 2 to PMM 3
  - Upgrade PMM Server on AWS
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
    
    None
    
    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
    
    Filters Panel
    
    Details Panel
- 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
  - Integrate PMM with Percona Platform
  - Connect PMM to Percona Platform
Administer
Administer
- About PMM administration
- Manage users
  Manage users
- Roles and permissions
  Roles and permissions
  - About roles and permissions in PMM
  - Access Control
    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
- Developing Advisor checks
- 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 Cluster Summary
    
    MongoDB Instance Summary
    
    MongoDB Instances Overview
    
    MongoDB Instances Compare
    
    MongoDB ReplSet 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

View

2024-05-07

Was this page helpful?

Thank you for your feedback!

Thank you for your feedback! Help us improve by following this feedback form.

Made with Material for MkDocs