Terminology Reference

Data retention

By default, Prometheus stores time-series data for 30 days, and QAN stores query data for 8 days.

Depending on available disk space and your requirements, you may need to adjust data retention time.

You can control data retention via the Settings dashboard.

Data Source Name

A database server attribute found on the QAN page. It informs how PMM connects to the selected database.

Grand Total Time

Grand Total Time.(percent of grand total time) is the percentage of time that the database server spent running a specific query, compared to the total time it spent running all queries during the selected period of time.

External Monitoring Service

A monitoring service which is not provided by PMM directly. It is bound to a running Prometheus exporter. As soon as such an service is added, you can set up the Metrics Monitor to display its graphs.

Metrics

A series of data which are visualized in PMM.

Metrics Monitor (MM)

Component of PMM Server that provides a historical view of metrics critical to a MySQL server instance.

Monitoring service

A special service which collects information from the database instance where PMM Client is installed.

To add a monitoring service, use the pmm-admin add command.

See also

Passing parameters to a monitoring service
pmm.pmm-admin.monitoring-service.pass-parameter

PMM

Percona Monitoring and Management

pmm-admin

A program which changes the configuration of the PMM Client. See detailed documentation in the pmm-admin section.

PMM Client

Collects MySQL server metrics, general system metrics, and query analytics data for a complete performance overview.

The collected data is sent to PMM Server.

For more information, see Client/Server Architecture - an Overview.

PMM Docker Image

A docker image which enables installing the PMM Server by using docker.

See also

Installing PMM Server using Docker
run-server-docker

PMM Home Page

The starting page of the PMM portal from which you can have an overview of your environment, open the tools of PMM, and browse to online resources.

On the PMM home page, you can also find the version number and a button to update your PMM Server (see PMM Version).

PMM Server

Aggregates data collected by PMM Client and presents it in the form of tables, dashboards, and graphs in a web interface.

PMM Server combines the backend API and storage for collected data with a frontend for viewing time-based graphs and performing thorough analysis of your MySQL and MongoDB hosts through a web interface.

Run PMM Server on a host that you will use to access this data.

See also

PMM Architecture

PMM Server Version

If PMM Server is installed via Docker, you can check the current PMM Server version by running docker exec:

Run this command as root or by using the sudo command

$ docker exec -it pmm-server head -1 /srv/update/main.yml
# v1.5.3

PMM user permissions for AWS

When creating a IAM user for Amazon RDS DB instance that you intend to monitor in PMM, you need to set all required permissions properly. For this, you may copy the following JSON for your IAM user:

{ "Version": "2012-10-17",
  "Statement": [{ "Sid": "Stmt1508404837000",
                  "Effect": "Allow",
                  "Action": [ "rds:DescribeDBInstances",
                              "cloudwatch:GetMetricStatistics",
                              "cloudwatch:ListMetrics"],
                              "Resource": ["*"] },
                 { "Sid": "Stmt1508410723001",
                   "Effect": "Allow",
                   "Action": [ "logs:DescribeLogStreams",
                               "logs:GetLogEvents",
                               "logs:FilterLogEvents" ],
                               "Resource": [ "arn:aws:logs:*:*:log-group:RDSOSMetrics:*" ]}
               ]
}

See also

Creating an IAM user
Creating an IAM user

PMM Version

The version of PMM appears at the bottom of the PMM server home page.

_images/pmm.home-page.1.png

To update your PMM Server, click the Check for Updates Manually button located next to the version number.

See also

Checking the version of PMM Server

Query Analytics (QAN)

Component of PMM Server that enables you to analyze MySQL query performance over periods of time.

Query Load

The percentage of time that the MySQL server spent executing a specific query.

Query Metrics Summary Table

An element of Query Analytics (QAN) which displays the available metrics for the selected query.

Query Metrics Table

A tool within QAN which lists metrics applicable to the query selected in the query summary table.

Query Summary Table

A tool within QAN which lists the queries which were run on the selected database server during the selected time or date range.

Quick ranges

Predefined time periods which are used by QAN to collect metrics for queries. The following quick ranges are available:

  • last hour
  • last three hours
  • last five hours
  • last twelve hours
  • last twenty four hours
  • last five days

Selected Time or Date Range

A predefined time period (see Quick ranges), such as 1 hour, or a range of dates that QAN uses to collects metrics.

Telemetry

Percona may collect some statistics about the machine where PMM is running.

This statistics includes the following information:

  • PMM Server unique ID
  • PMM version
  • The name and version of the operating system, AMI or virtual appliance
  • MySQL version
  • Perl version

You may disable telemetry on the Settings dashboard.

Version

A database server attribute found on the QAN page. it informs the full version of the monitored database server, as well as the product name, revision and release number.

Table Of Contents

Previous topic

Contacting and Contributing

Next topic

Frequently Asked Questions