Developing Advisor checks¶

PMM offers sets of checks that can detect common security threats, performance degradation, data loss and data corruption.

As a developer, you can create custom checks to cover additional use cases, relevant to your specific database infrastructure.

Check components¶

A check is a combination of:

A query for extracting data from the database.
Python script for converting extracted data into check results. This is actually a Starlark script, which is a Python dialect that adds more imperative features than Python. The script’s execution environment is sandboxed, and no I/O can be done from it.

All checks are self-contained in the first phase, as well as in most of the planned phases.

This means that extracted data is processed on the PMM side and not sent back to Percona Platform.

Backend¶

pmm-managed checks that the installation is opted-in for checks.
pmm-managed downloads files with checks from Percona Platform.
pmm-managed verifies file signatures using a list of hard-coded public keys. At least one signature should be correct.
pmm-managed sends queries to pmm-agent and gathers results.
pmm-managed executes check scripts that produce alert information.
pmm-managed sends alerts to Alertmanager.
Due to Alertmanager design, pmm-managed has to send and re-send alerts to it much more often than the frequency with which checks are executed. This expected behavior is not important for using checks but is important for understanding how checks work.
Currently, Prometheus is not involved.

Frontend¶

PMM uses Alertmanager API to get information about failed checks and show them on the UI:

Check format versions¶

Starting with the 2.28 release, PMM uses Advisor checks format version 2. Format version 1 is deprecated.

Version 2 advisor checks for PMM 2.28 and newer¶

PMM 2.28 upgraded Advisor Checks to version 2, which uses a slightly different structure than version 1 checks, created in 2.7 and earlier. This is because, compared to version 1 checks, checks created in 2.28 and later offer additional support for:

Multiple queries
Victoria Metrics as a data source
Database Family field

Format for v.2 checks¶

Advisor checks for PMM 2.28 and later use the following format:

Version 2 Checks Format

---
checks:
  - version: 2
    name: exampleV2
    summary: Check format V2
    description: Checks something important
    interval: standard
    family: MYSQL
    category: configuration ## Deprecated since PMM 2.36
    advisor: dev            ## Required since PMM 2.36
    queries:
      - type: MYSQL_SHOW
        query: VARIABLES

      - type: METRICS_INSTANT
        query: mysql_global_status_uptime{service_name=~"{{.ServiceName}}"}

      - type: METRICS_INSTANT
        query: mysql_global_status_uptime{service_name=~"{{.ServiceName}}"}
        parameters:
          lookback: 5m

      - type: METRICS_RANGE
        query: avg by (node_name) (avg_over_time(node_load1{node_name=~"{{.NodeName}}"}[5m]))
        parameters:
          range: 15m
          step: 5m

      - type: METRICS_RANGE
        query: avg by (node_name) (avg_over_time(node_load1{node_name=~"{{.NodeName}}"}[5m]))
        parameters:
          lookback: 5m
          range: 15m
          step: 5m

    script: |
      def check_context(docs, context):
          # `docs` is a frozen (deeply immutable) list where each item represents single query results. Order of results
          # matches order of queries in check file. Each query result is list of dicts where each item where each dict
          # represents a single document in result set.
          #
          # `context` is a dict with additional functions.
          #
          # Global `print` and `fail` functions are available.
          #
          # `check_context` function is expected to return a list of dicts that are then converted to alerts;
          # in particular, that list can be empty.
          # Any other value (for example, string) is treated as a script execution failure
          # (Starlark does not support Python exceptions);
          # it is recommended to use global function `fail` for that instead.

          results = []

          for row in docs[0]:
              name, value = row["Variable_name"], row["Value"]
              if name == "version":
                  results.append({
                      "summary": "MySQL has version {}".format(value),
                      "description": "Current version is {}".format(value),
                      "read_more_url": "",
                      "severity": "warning",
                      "labels": {},
                  })

          uptimeNow = int(int(docs[1][0]["value"][1])/60)
          results.append({
              "summary": "MySQL uptime {} min".format(uptimeNow),
              "description": "Current uptime is {} min".format(uptimeNow),
              "read_more_url": "",
              "severity": "warning",
              "labels": {},
          })

          uptimeFiveMinAgo = int(int(docs[2][0]["value"][1])/60)
          results.append({
              "summary": "MySQL uptime 5 min ago was {} min".format(uptimeFiveMinAgo),
              "description": "5 min ago uptime was {} min".format(uptimeFiveMinAgo),
              "read_more_url": "",
              "severity": "warning",
              "labels": {},
          })

          dataPoints = []
          for row in docs[3][0]["values"]:
            dataPoints.append(row[1])

          results.append({
              "summary": "Node has load average for last 15 minutes {}".format(dataPoints),
              "description": "Data points {}".format(dataPoints),
              "read_more_url": "",
              "severity": "warning",
              "labels": {},
          })

          dataPoints = []
          for row in docs[4][0]["values"]:
              dataPoints.append(row[1])

          results.append({
              "summary": "Five minutes ago node had load average for 15 minutes {}".format(dataPoints),
              "description": "Data points {}".format(dataPoints),
              "read_more_url": "",
              "severity": "warning",
              "labels": {},
          })

          return results

Checks script¶

The check script assumes that there is a function with check_context, that accepts a list where each item represents the result of a single query specified in the check. Each result itself is a list of docs containing returned rows for SQL databases and documents for MongoDB. It returns zero, one, or several check results that are then converted to alerts.

Check severity levels¶

You can label your advisor checks with one of the following available severity levels: Emergency, Alert, Critical, Error, Warning, Notice, Info, Debug. PMM groups failed checks by their severity, and displays them under Advisors Checks > Failed Checks.

Check fields¶

Checks can include the following fields:

Version (integer, required): defines what other properties are expected, what types are supported, what is expected from the script and what it can expect from the execution environment, etc.
Name (string, required): defines machine-readable name (ID).
Summary (string, required): defines short human-readable description.
Description (string, required): defines long human-readable description.
Family (string, required): specifies one of the supported database families: MYSQL, POSTGRESQL, MONGODB. This field is only available for Advisor checks v.2, created for PMM 2.28 and later.
Advisor (string, required): specifies the advisor to which this check belongs. For local environments, specify dev.
Interval (string/enum, optional): defines running interval. Can be one of the predefined intervals in the UI: Standard, Frequent, Rare.
Queries (array, required): contains items that specify queries.
- Type (string/enum, required): defines the query type. Check the list of available types in the table below.
- Query (string, can be absent if the type defines the whole query by itself): The query is executed on the PMM Client side and can contain multiple queries specific to the target DBMS.
- Parameters (key-value, can be absent if query doesn’t have required parameters)
Script (string, required): contains a small Starlark script that processes query results, and returns check results. It is executed on the PMM Server side.

Query types¶

Expand the table below for the list of checks types that you can use to define your query type and the PMM Service type for which the check will run.

Check Types table

Check type	Description	“query” required (must be empty if “No”)
MYSQL_SHOW	Executes ‘SHOW …’ clause against MySQL database.	Yes
MYSQL_SELECT	Executes ‘SELECT …’ clause against MySQL database.	Yes
POSTGRESQL_SHOW	Executes ‘SHOW ALL’ command against PosgreSQL database.	No
POSTGRESQL_SELECT	Executes ‘SELECT …’ clause against PosgreSQL database.	Yes
MONGODB_GETPARAMETER	Executes db.adminCommand( { getParameter: “*” } ) against MongoDB’s “admin” database. For more information, see getParameter	No
MONGODB_BUILDINFO	Executes db.adminCommand( { buildInfo: 1 } ) against MongoDB’s “admin” database. For more information, see buildInfo	No
MONGODB_GETCMDLINEOPTS	Executes db.adminCommand( { getCmdLineOpts: 1 } ) against MongoDB’s “admin” database. For more information, see getCmdLineOpts	No
MONGODB_REPLSETGETSTATUS	Executes db.adminCommand( { replSetGetStatus: 1 } ) against MongoDB’s “admin” database. For more information, see replSetGetStatus	No
MONGODB_GETDIAGNOSTICDATA	Executes db.adminCommand( { getDiagnosticData: 1 } ) against MongoDB’s “admin” database. For more information, see MongoDB Performance	No
METRICS_INSTANT	Executes instant MetricsQL query. Query can use placeholders in query string {{.NodeName}} and {{.ServiceName}} . Both match target service/node names. To read more about instant queries, check out the Prometheus docs.	Yes
METRICS_RANGE	Executes range MetricsQL query. Query can use placeholders in query string {{.NodeName}} and {{.ServiceName}} . Both match target service/node names. To read more about range queries, check out the Prometheus docs.	Yes
CLICKHOUSE_SELECT	Executes ‘SELECT …’ statements against PMM’s Query Analytics Clickhouse database. Queries can use the {{.ServiceName}} and {{.ServiceID}} placeholders in query string. They match the target service name and service ID respectively.	Yes

Query parameters¶

METRICS_INSTANT
- lookback (duration, optional): specifies how far in past to look back to metrics history. If this parameter is not specified, then query executed on the latest data. Example values: 30s, 5m, 8h.
METRICS_RANGE
- lookback (duration, optional): specifies how far in past to look back to metrics history. If this parameter is not specified, then query executed on the latest data. Example values: 30s, 5m, 8h.
- range (duration, required): specifies time window of the query. This parameter is equal to Prometheus API.
- step (duration, required): query resolution. This parameter is equal to Prometheus API.
POSTGRESQL_SELECT
- all_dbs (boolean, optional): execute query on all available databases in PostgreSQL instance. If this parameter is not specified, then query executed on the default database (the one that was specified when service was added to PMM).

Develop checks¶

Development / Debugging Only

Note that check development in PMM is currently for debugging only and NOT for production use! Future releases plan to include the option to run custom local checks in addition to hosted Percona Platform checks.

To develop custom checks for PMM:

Install the latest PMM Server and PMM Client builds following the installation instructions.
Run PMM Server with special environment variables:
- PERCONA_TEST_CHECKS_FILE=/srv/custom-checks.yml to use checks from the local files instead of downloading them from Percona Platform.
- PERCONA_TEST_CHECKS_DISABLE_START_DELAY=true to disable the default check execution start delay. This is currently set to one minute, so that checks run upon system start.
- PERCONA_TEST_CHECKS_RESEND_INTERVAL=2s to define the frequency for sending the SA-based alerts to Alertmanager.
```
docker run -p 80:80 -p 443:443 --name pmm-server \
-e PERCONA_TEST_CHECKS_FILE=/srv/custom-checks.yml \
-e PERCONA_TEST_CHECKS_DISABLE_START_DELAY=true \
-e PERCONA_TEST_CHECKS_RESEND_INTERVAL=2s \
perconalab/pmm-server:dev-latest
```
Log in to Grafana with credentials admin/admin.
Go to Configuration > Settings > Advanced Settings and make sure the Advisors option is enabled.
Create /srv/custom-checks.yml inside the pmm-server container with the content of your check. Specify dev advisor in your check.
The checks will run according to the time interval defined on the UI. You can see the result of running the check on the home dashboard:
Click on the number of failed checks to open the Failed Checks dashboard:

Check out pmm-managed logs:

docker exec -it pmm-server supervisorctl tail -f pmm-managed

Troubleshooting and tips¶

in Debug mode, PMM generates a lot of redundant information in the log files, information that is not useful for developing checks. If debug logging is enabled, you can disable it with the following environment variable: PMM_DEBUG=0.
All logs from checks subsystem has component=checks tag, so you can just filter pmm-managed logs with grep.
Local check file should always be linked to fake dev advisor: advisor: dev. If PMM does not display the Development tab on the Advisors page, make sure that you specify dev advisor in the check file.
If this still doesn’t display the Development tab, probably PMM could not load your file due to formatting issues. Check pmm-managed logs for details.
There are to ways to reload the check file:
Click Run check button (but it’s unavailable if you don’t have any tabs on advisors page and most likely that is the case during development)
Reload managed: supervisorctl restart pmm-managed (execute inside PMM server)

Submit feedback¶

We welcome your feedback on the current process for developing and debugging checks. Send us your comments over Slack or post a question on the Percona Forums.

Get expert help¶

If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services.

Community Forum Get a Percona Expert

Last update: 2024-04-18