Buy Percona ServicesBuy Now!

Percona Monitoring and Management Architecture

The PMM platform is based on a client-server model that enables scalability. It includes the following modules:

  • PMM Client installed on every database host that you want to monitor. It collects server metrics, general system metrics, and Query Analytics data for a complete performance overview.
  • PMM Server is the central part of PMM that aggregates collected data and presents it in the form of tables, dashboards, and graphs in a web interface.

The modules are packaged for easy installation and usage. It is assumed that the user should not need to understand what are the exact tools that make up each module and how they interact. However, if you want to leverage the full potential of PMM, the internal structure is important.

PMM is a collection of tools designed to seamlessly work together. Some are developed by Percona and some are third-party open-source tools.

Note

The overall client-server model is not likely to change, but the set of tools that make up each component may evolve with the product.

The following diagram illustrates how PMM is currently structured:

_images/pmm-diagram.png

PMM Client

PMM Client packages are available for most popular Linux distributions:

  • DEB for Debian-based distributions (including Ubuntu and others)
  • RPM for Red Hat Enterprise Linux derivatives (including CentOS, Oracle Linux, Amazon Linux, and others)

There are also generic tarball binaries that can be used on any Linux system.

For more information, see Installing PMM Client.

PMM Client packages consist of the following:

  • pmm-admin is a command-line tool for managing PMM Client, for example, adding and removing database instances that you want to monitor. For more information, see Managing PMM Client.
  • pmm-mysql-queries-0 is a service that manages the QAN agent as it collects query performance data from MySQL and sends it to the QAN API on PMM Server.
  • pmm-mongodb-queries-0 is a service that manages the QAN agent as it collects query performance data from MongoDB and sends it to QAN API on PMM Server.
  • node_exporter is a Prometheus exporter that collects general system metrics. For more information, see https://github.com/percona/node_exporter.
  • mysqld_exporter is a Prometheus exporter that collects MySQL server metrics. For more information, see https://github.com/percona/mysqld_exporter.
  • mongodb_exporter is a Prometheus exporter that collects MongoDB server metrics. For more information, see https://github.com/percona/mongodb_exporter.
  • proxysql_exporter is a Prometheus exporter that collects ProxySQL performance metrics. For more information, see https://github.com/percona/proxysql_exporter.

PMM Server

PMM Server runs on the machine that will be your central monitoring host. It is distributed as an appliance via the following:

  • Docker image that you can use to run a container
  • Open Virtual Appliance (OVA) that you can run in VirtualBox or another hypervisor
  • AMI (Amazon Machine Image) that you can run via AWS (Amazon Web Services)

For more information, see Installing PMM Server.

PMM Server includes the following tools:

  • QAN (Query Analytics) enables you to analyze MySQL query performance over periods of time. In addition to the client-side QAN agent, it includes the following:

    • QAN API is the backend for storing and accessing query data collected by the QAN agent running on a PMM Client.
    • QAN Web App is a web application for visualizing collected Query Analytics data.

  • Metrics Monitor provides a historical view of metrics that are critical to a MySQL or MongoDB server instance. It includes the following:

    • Prometheus is a third-party time-series database that connects to exporters running on a PMM Client and aggregates metrics collected by the exporters. For more information, see Prometheus Docs [3].

      • Consul provides an API that a PMM Client can use to remotely list, add, and remove hosts for Prometheus. It also stores monitoring metadata. For more information, see Consul Docs [4].

        Warning

        Although the Consul web UI is accessible, do not make any changes to the configuration.

    • Grafana is a third-party dashboard and graph builder for visualizing data aggregated by Prometheus in an intuitive web interface. For more information, see Grafana Docs [2].

      • Percona Dashboards is a set of dashboards for Grafana developed by Percona.

  • Orchestrator is a MySQL replication topology management and visualization tool. For more information, see: Orchestrator Manual [1].

All tools can be accessed from the PMM Server web interface (landing page). For more information, see Using the Percona Monitoring and Management Platform.

See also

Default ports
Ports in Terminology Reference
Enabling orchestrator
Orchestrator in Terminology Reference

References

[1]https://github.com/outbrain/orchestrator/wiki/Orchestrator-Manual
[2]http://docs.grafana.org/
[3]https://prometheus.io/docs/introduction/overview/
[4]https://www.consul.io/docs/
Download PDF Manual

Table Of Contents

Previous topic

Percona Monitoring and Management Documentation

Next topic

Deploying Percona Monitoring and Management

Visit Percona Store

General Inquiries

For general inquiries, please send us your question and someone will contact you.


Ask Me!